--- a/Documentation/Source/eric5.Utilities.ClassBrowsers.rbclbr.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Utilities.ClassBrowsers.rbclbr.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,12 +22,12 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Utilities.ClassBrowsers.rbclbr</h1>
 <p>
-&#80;&#97;&#114;&#115;&#101; &#97; &#82;&#117;&#98;y &#102;&#105;&#108;&#101; &#97;&#110;&#100; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115;, &#109;&#111;&#100;&#117;&#108;&#101;&#115;, &#109;&#101;&#116;&#104;&#111;&#100;&#115; &#97;&#110;&#100; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115;.
+Parse a Ruby file and retrieve classes, modules, methods and attributes.
 </p><p>
-&#80;&#97;&#114;&#115;&#101; &#101;&#110;&#111;&#117;&#103;&#104; &#111;&#102; &#97; &#82;&#117;&#98;y &#102;&#105;&#108;&#101; &#116;&#111; &#114;&#101;&#99;&#111;&#103;&#110;&#105;z&#101; &#99;&#108;&#97;&#115;&#115;, &#109;&#111;&#100;&#117;&#108;&#101; &#97;&#110;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#100;&#101;&#102;&#105;&#110;&#105;&#116;&#105;&#111;&#110;&#115;
-&#97;&#110;&#100; &#116;&#111; &#102;&#105;&#110;&#100; &#111;&#117;&#116; &#116;&#104;&#101; &#115;&#117;&#112;&#101;&#114;&#99;&#108;&#97;&#115;&#115;&#101;&#115; &#111;&#102; &#97; &#99;&#108;&#97;&#115;&#115; &#97;&#115; w&#101;&#108;&#108; &#97;&#115; &#105;&#116;&#115; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115;.
+Parse enough of a Ruby file to recognize class, module and method definitions
+and to find out the superclasses of a class as well as its attributes.
 </p><p>
-&#73;&#116; &#105;&#115; &#98;&#97;&#115;&#101;&#100; &#111;&#110; &#116;&#104;&#101; &#80;y&#116;&#104;&#111;&#110; &#99;&#108;&#97;&#115;&#115; &#98;&#114;&#111;w&#115;&#101;&#114; &#102;&#111;&#117;&#110;&#100; &#105;&#110; &#116;&#104;&#105;&#115; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
+It is based on the Python class browser found in this package.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -37,33 +37,33 @@
 <table>
 <tr>
 <td><a href="#Attribute">Attribute</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97; &#99;&#108;&#97;&#115;&#115; &#111;&#114; &#109;&#111;&#100;&#117;&#108;&#101; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;.</td>
+<td>Class to represent a class or module attribute.</td>
 </tr><tr>
 <td><a href="#Class">Class</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97; &#82;&#117;&#98;y &#99;&#108;&#97;&#115;&#115;.</td>
+<td>Class to represent a Ruby class.</td>
 </tr><tr>
 <td><a href="#Function">Function</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97; &#82;&#117;&#98;y &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;.</td>
+<td>Class to represent a Ruby function.</td>
 </tr><tr>
 <td><a href="#Module">Module</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101;.</td>
+<td>Class to represent a Ruby module.</td>
 </tr><tr>
 <td><a href="#VisibilityMixin">VisibilityMixin</a></td>
-<td>&#77;&#105;x&#105;&#110; &#99;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#110;&#111;&#116;&#105;&#111;&#110; &#111;&#102; v&#105;&#115;&#105;&#98;&#105;&#108;&#105;&#116;y.</td>
+<td>Mixin class implementing the notion of visibility.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <tr>
 <td><a href="#readmodule_ex">readmodule_ex</a></td>
-<td>&#82;&#101;&#97;&#100; &#97; &#82;&#117;&#98;y &#102;&#105;&#108;&#101; &#97;&#110;&#100; &#114;&#101;&#116;&#117;&#114;&#110; &#97; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#111;&#102; &#99;&#108;&#97;&#115;&#115;&#101;&#115;, &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; &#97;&#110;&#100; &#109;&#111;&#100;&#117;&#108;&#101;&#115;.</td>
+<td>Read a Ruby file and return a dictionary of classes, functions and modules.</td>
 </tr>
 </table>
 <hr /><hr />
 <a NAME="Attribute" ID="Attribute"></a>
 <h2>Attribute</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97; &#99;&#108;&#97;&#115;&#115; &#111;&#114; &#109;&#111;&#100;&#117;&#108;&#101; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;.
+    Class to represent a class or module attribute.
 </p>
 <h3>Derived from</h3>
 ClbrBaseClasses.Attribute, VisibilityMixin
@@ -75,27 +75,27 @@
 <table>
 <tr>
 <td><a href="#Attribute.__init__">Attribute</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr>
 </table>
 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a>
 <h4>Attribute (Constructor)</h4>
 <b>Attribute</b>(<i>module, name, file, lineno</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>module</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+name of the module containing this class
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+name of this class
 </dd><dt><i>file</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;
+filename containing this attribute
 </dd><dt><i>lineno</i></dt>
 <dd>
-&#108;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#100;&#101;&#102;&#105;&#110;&#105;&#116;&#105;&#111;&#110;
+linenumber of the class definition
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -103,7 +103,7 @@
 <a NAME="Class" ID="Class"></a>
 <h2>Class</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97; &#82;&#117;&#98;y &#99;&#108;&#97;&#115;&#115;.
+    Class to represent a Ruby class.
 </p>
 <h3>Derived from</h3>
 ClbrBaseClasses.Class, VisibilityMixin
@@ -115,30 +115,30 @@
 <table>
 <tr>
 <td><a href="#Class.__init__">Class</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr>
 </table>
 <a NAME="Class.__init__" ID="Class.__init__"></a>
 <h4>Class (Constructor)</h4>
 <b>Class</b>(<i>module, name, super, file, lineno</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>module</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+name of the module containing this class
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+name of this class
 </dd><dt><i>super</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#99;&#108;&#97;&#115;&#115; &#110;&#97;&#109;&#101;&#115; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115; &#105;&#115; &#105;&#110;&#104;&#101;&#114;&#105;&#116;&#101;&#100; &#102;&#114;&#111;&#109;
+list of class names this class is inherited from
 </dd><dt><i>file</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+filename containing this class
 </dd><dt><i>lineno</i></dt>
 <dd>
-&#108;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#100;&#101;&#102;&#105;&#110;&#105;&#116;&#105;&#111;&#110;
+linenumber of the class definition
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -146,7 +146,7 @@
 <a NAME="Function" ID="Function"></a>
 <h2>Function</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97; &#82;&#117;&#98;y &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;.
+    Class to represent a Ruby function.
 </p>
 <h3>Derived from</h3>
 ClbrBaseClasses.Function, VisibilityMixin
@@ -158,33 +158,33 @@
 <table>
 <tr>
 <td><a href="#Function.__init__">Function</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr>
 </table>
 <a NAME="Function.__init__" ID="Function.__init__"></a>
 <h4>Function (Constructor)</h4>
 <b>Function</b>(<i>module, name, file, lineno, signature = '', separator = ', '</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>module</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;
+name of the module containing this function
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;
+name of this function
 </dd><dt><i>file</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+filename containing this class
 </dd><dt><i>lineno</i></dt>
 <dd>
-&#108;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#100;&#101;&#102;&#105;&#110;&#105;&#116;&#105;&#111;&#110;
+linenumber of the class definition
 </dd><dt><i>signature</i></dt>
 <dd>
-&#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#108;&#105;&#115;&#116; &#111;&#102; &#116;&#104;&#101; &#109;&#101;&#116;&#104;&#111;&#100;
+parameterlist of the method
 </dd><dt><i>separator</i></dt>
 <dd>
-&#115;&#116;&#114;&#105;&#110;&#103; &#115;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;
+string separating the parameters
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -192,7 +192,7 @@
 <a NAME="Module" ID="Module"></a>
 <h2>Module</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#116;&#111; &#114;&#101;&#112;&#114;&#101;&#115;&#101;&#110;&#116; &#97; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101;.
+    Class to represent a Ruby module.
 </p>
 <h3>Derived from</h3>
 ClbrBaseClasses.Module, VisibilityMixin
@@ -204,27 +204,27 @@
 <table>
 <tr>
 <td><a href="#Module.__init__">Module</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr>
 </table>
 <a NAME="Module.__init__" ID="Module.__init__"></a>
 <h4>Module (Constructor)</h4>
 <b>Module</b>(<i>module, name, file, lineno</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>module</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+name of the module containing this class
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+name of this class
 </dd><dt><i>file</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115;
+filename containing this class
 </dd><dt><i>lineno</i></dt>
 <dd>
-&#108;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#100;&#101;&#102;&#105;&#110;&#105;&#116;&#105;&#111;&#110;
+linenumber of the class definition
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -232,7 +232,7 @@
 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a>
 <h2>VisibilityMixin</h2>
 <p>
-    &#77;&#105;x&#105;&#110; &#99;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#110;&#111;&#116;&#105;&#111;&#110; &#111;&#102; v&#105;&#115;&#105;&#98;&#105;&#108;&#105;&#116;y.
+    Mixin class implementing the notion of visibility.
 </p>
 <h3>Derived from</h3>
 ClbrBaseClasses.ClbrVisibilityMixinBase
@@ -244,14 +244,14 @@
 <table>
 <tr>
 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td>
-<td>&#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#116;&#104;&#101; v&#105;&#115;&#105;&#98;&#105;&#108;&#105;&#116;y.</td>
+<td>Method to initialize the visibility.</td>
 </tr>
 </table>
 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a>
 <h4>VisibilityMixin (Constructor)</h4>
 <b>VisibilityMixin</b>(<i></i>)
 <p>
-        &#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#116;&#104;&#101; v&#105;&#115;&#105;&#98;&#105;&#108;&#105;&#116;y.
+        Method to initialize the visibility.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -259,19 +259,19 @@
 <h2>readmodule_ex</h2>
 <b>readmodule_ex</b>(<i>module, path=[]</i>)
 <p>
-    &#82;&#101;&#97;&#100; &#97; &#82;&#117;&#98;y &#102;&#105;&#108;&#101; &#97;&#110;&#100; &#114;&#101;&#116;&#117;&#114;&#110; &#97; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#111;&#102; &#99;&#108;&#97;&#115;&#115;&#101;&#115;, &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; &#97;&#110;&#100; &#109;&#111;&#100;&#117;&#108;&#101;&#115;.
+    Read a Ruby file and return a dictionary of classes, functions and modules.
 </p><dl>
 <dt><i>module</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#82;&#117;&#98;y &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the Ruby file (string)
 </dd><dt><i>path</i></dt>
 <dd>
-&#112;&#97;&#116;&#104; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#115;&#101;&#97;&#114;&#99;&#104;&#101;&#100; &#105;&#110; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+path the file should be searched in (list of strings)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#114;&#101;&#115;&#117;&#108;&#116;&#105;&#110;&#103; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y
+the resulting dictionary
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>