src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.rbclbr.html

branch
eric7
changeset 10259
b51dfacef37f
parent 10070
9f5758c0fec1
child 10433
328f3ec4b77a
diff -r e7764f992a01 -r b51dfacef37f src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.rbclbr.html
--- a/src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.rbclbr.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.rbclbr.html	Fri Oct 27 14:09:40 2023 +0200
@@ -54,7 +54,7 @@
 
 <tr>
 <td><a href="#readmodule_ex">readmodule_ex</a></td>
-<td></td>
+<td>Read a Ruby file and return a dictionary of classes, functions and modules.</td>
 </tr>
 <tr>
 <td><a href="#scan">scan</a></td>
@@ -370,6 +370,36 @@
 <h2>readmodule_ex</h2>
 <b>readmodule_ex</b>(<i>module, path=None, isTypeFile=False</i>)
 
+<p>
+    Read a Ruby file and return a dictionary of classes, functions and modules.
+</p>
+<dl>
+
+<dt><i>module</i> (str)</dt>
+<dd>
+name of the Ruby file
+</dd>
+<dt><i>path</i> (list of str)</dt>
+<dd>
+path the file should be searched in
+</dd>
+<dt><i>isTypeFile</i> (bool)</dt>
+<dd>
+flag indicating a file of this type
+</dd>
+</dl>
+<dl>
+<dt>Return:</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 />
 <hr />

eric ide

mercurial