Documentation/Source/eric6.Utilities.ClassBrowsers.__init__.html

changeset 5977
8a0ec75b0f73
parent 5651
982465f8389c
--- a/Documentation/Source/eric6.Utilities.ClassBrowsers.__init__.html	Sat Nov 18 12:35:13 2017 +0100
+++ b/Documentation/Source/eric6.Utilities.ClassBrowsers.__init__.html	Sat Nov 18 18:27:25 2017 +0100
@@ -28,13 +28,16 @@
 </p><p>
 <ul>
 <li>CORBA IDL</li>
-<li>Python</li>
+<li>JavaScript</li>
+<li>ProtoBuf</li>
+<li>Python 2</li>
+<li>Python 3</li>
 <li>Ruby</li>
 </ul>
 </p>
 <h3>Global Attributes</h3>
 <table>
-<tr><td>IDL_SOURCE</td></tr><tr><td>JS_SOURCE</td></tr><tr><td>PTL_SOURCE</td></tr><tr><td>PY_SOURCE</td></tr><tr><td>RB_SOURCE</td></tr><tr><td>SUPPORTED_TYPES</td></tr><tr><td>__extensions</td></tr>
+<tr><td>IDL_SOURCE</td></tr><tr><td>JS_SOURCE</td></tr><tr><td>PROTO_SOURCE</td></tr><tr><td>PTL_SOURCE</td></tr><tr><td>PY_SOURCE</td></tr><tr><td>RB_SOURCE</td></tr><tr><td>SUPPORTED_TYPES</td></tr><tr><td>__extensions</td></tr>
 </table>
 <h3>Classes</h3>
 <table>
@@ -57,20 +60,20 @@
 <p>
     Module function to extend the Python module finding mechanism.
 </p><p>
-    This function searches for files in the given path. If the filename
-    doesn't have an extension or an extension of .py, the normal search
-    implemented in the imp module is used. For all other supported files
-    only path is searched.
+    This function searches for files in the given list of paths. If the
+    file name doesn't have an extension or an extension of .py, the normal
+    Python search implemented in the imp module is used. For all other
+    supported files only the paths list is searched.
 </p><dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-filename or modulename to search for (string)
-</dd><dt><i>path</i></dt>
+file name or module name to search for
+</dd><dt><i>path</i> (list of str)</dt>
 <dd>
-search path (list of strings)
-</dd><dt><i>isPyFile</i></dt>
+search paths
+</dd><dt><i>isPyFile</i> (bool)</dt>
 <dd>
-flag indicating a Python file (boolean)
+flag indicating a Python file
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -79,6 +82,11 @@
         is a tuple of file suffix, file mode and file type)
 </dd>
 </dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple
+</dd>
+</dl><dl>
 <dt>Raises <b>ImportError</b>:</dt>
 <dd>
 The file or module wasn't found.
@@ -96,21 +104,26 @@
     The real work of parsing the source file is delegated to the individual
     file parsers.
 </p><dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of the source file (string)
-</dd><dt><i>path</i></dt>
+name of the source file
+</dd><dt><i>path</i> (list of str)</dt>
 <dd>
-path the file should be searched in (list of strings)
-</dd><dt><i>isPyFile</i></dt>
+list of paths the file should be searched in
+</dd><dt><i>isPyFile</i> (bool)</dt>
 <dd>
-flag indicating a Python file (boolean)
+flag indicating a Python file
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 the resulting dictionary
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial