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

changeset 7693
a51f82458a1b
parent 7641
21ea4fd50b0a
child 7698
12cb12380a6a
diff -r 94f0017f9372 -r a51f82458a1b eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html
--- a/eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html	Sun Sep 06 12:19:56 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html	Sun Sep 06 12:33:50 2020 +0200
@@ -79,6 +79,10 @@
 <td><a href="#readmodule_ex">readmodule_ex</a></td>
 <td>Read a module file and return a dictionary of classes.</td>
 </tr>
+<tr>
+<td><a href="#scan">scan</a></td>
+<td>Public method to scan the given source text.</td>
+</tr>
 </table>
 <hr />
 <hr />
@@ -632,21 +636,21 @@
 </p>
 <dl>
 
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of the module file (string)
+name of the module file
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (list of str)</dt>
 <dd>
-path the module should be searched in (list of strings)
+path the module should be searched in
 </dd>
-<dt><i>inpackage</i></dt>
+<dt><i>inpackage</i> (bool)</dt>
 <dd>
 flag indicating a module inside a package is scanned
 </dd>
-<dt><i>isPyFile</i></dt>
+<dt><i>isPyFile</i> (bool)</dt>
 <dd>
-flag indicating a Python file (boolean)
+flag indicating a Python file
 </dd>
 </dl>
 <dl>
@@ -655,6 +659,49 @@
 the resulting dictionary
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="scan" ID="scan"></a>
+<h2>scan</h2>
+<b>scan</b>(<i>src, file, module</i>)
+
+<p>
+    Public method to scan the given source text.
+</p>
+<dl>
+
+<dt><i>src</i> (str)</dt>
+<dd>
+source text to be scanned
+</dd>
+<dt><i>file</i> (str)</dt>
+<dd>
+file name associated with the source text
+</dd>
+<dt><i>module</i> (str)</dt>
+<dd>
+module name associated with the source text
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+dictionary containing the extracted data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial