--- a/Documentation/Source/eric5.QScintilla.TypingCompleters.CompleterRuby.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.QScintilla.TypingCompleters.CompleterRuby.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.QScintilla.TypingCompleters.CompleterRuby</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#116;y&#112;&#105;&#110;&#103; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114; &#102;&#111;&#114; &#82;&#117;&#98;y.
+Module implementing a typing completer for Ruby.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#CompleterRuby">CompleterRuby</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;y&#112;&#105;&#110;&#103; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114; &#102;&#111;&#114; &#82;&#117;&#98;y.</td>
+<td>Class implementing typing completer for Ruby.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="CompleterRuby" ID="CompleterRuby"></a>
 <h2>CompleterRuby</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;y&#112;&#105;&#110;&#103; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114; &#102;&#111;&#114; &#82;&#117;&#98;y.
+    Class implementing typing completer for Ruby.
 </p>
 <h3>Derived from</h3>
 CompleterBase
@@ -55,118 +55,118 @@
 <table>
 <tr>
 <td><a href="#CompleterRuby.__init__">CompleterRuby</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#CompleterRuby.__inComment">__inComment</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#99;&#111;&#109;&#109;&#101;&#110;&#116;</td>
+<td>Private method to check, if the cursor is inside a comment</td>
 </tr><tr>
 <td><a href="#CompleterRuby.__inDoubleQuotedString">__inDoubleQuotedString</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#100;&#111;&#117;&#98;&#108;&#101; &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103;.</td>
+<td>Private method to check, if the cursor is within a double quoted string.</td>
 </tr><tr>
 <td><a href="#CompleterRuby.__inHereDocument">__inHereDocument</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#104;&#101;&#114;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.</td>
+<td>Private method to check, if the cursor is within a here document.</td>
 </tr><tr>
 <td><a href="#CompleterRuby.__inInlineDocument">__inInlineDocument</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97;&#110; &#105;&#110;&#108;&#105;&#110;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.</td>
+<td>Private method to check, if the cursor is within an inline document.</td>
 </tr><tr>
 <td><a href="#CompleterRuby.__inSingleQuotedString">__inSingleQuotedString</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103;.</td>
+<td>Private method to check, if the cursor is within a single quoted string.</td>
 </tr><tr>
 <td><a href="#CompleterRuby.charAdded">charAdded</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114;.</td>
+<td>Public slot called to handle the user entering a character.</td>
 </tr><tr>
 <td><a href="#CompleterRuby.readSettings">readSettings</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#114;&#101;&#114;&#101;&#97;&#100; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.</td>
+<td>Public slot called to reread the configuration parameters.</td>
 </tr>
 </table>
 <a NAME="CompleterRuby.__init__" ID="CompleterRuby.__init__"></a>
 <h4>CompleterRuby (Constructor)</h4>
 <b>CompleterRuby</b>(<i>editor, parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>editor</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#83;&#99;&#105;&#110;&#116;&#105;&#108;&#108;&#97;.&#69;&#100;&#105;&#116;&#111;&#114;)
+reference to the editor object (QScintilla.Editor)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;)
+reference to the parent object (QObject)
 </dd>
 </dl><a NAME="CompleterRuby.__inComment" ID="CompleterRuby.__inComment"></a>
 <h4>CompleterRuby.__inComment</h4>
 <b>__inComment</b>(<i>line, col</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#99;&#111;&#109;&#109;&#101;&#110;&#116;
+        Private method to check, if the cursor is inside a comment
 </p><dl>
 <dt><i>line</i></dt>
 <dd>
-&#99;&#117;&#114;&#114;&#101;&#110;&#116; &#108;&#105;&#110;&#101; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+current line (integer)
 </dd><dt><i>col</i></dt>
 <dd>
-&#99;&#117;&#114;&#114;&#101;&#110;&#116; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; w&#105;&#116;&#104;&#105;&#110; &#108;&#105;&#110;&#101; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+current position within line (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#99;&#111;&#109;&#109;&#101;&#110;&#116; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating, if the cursor is inside a comment (boolean)
 </dd>
 </dl><a NAME="CompleterRuby.__inDoubleQuotedString" ID="CompleterRuby.__inDoubleQuotedString"></a>
 <h4>CompleterRuby.__inDoubleQuotedString</h4>
 <b>__inDoubleQuotedString</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#100;&#111;&#117;&#98;&#108;&#101; &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103;.
+        Private method to check, if the cursor is within a double quoted string.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#100;&#111;&#117;&#98;&#108;&#101;
-            &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating, if the cursor is inside a double
+            quoted string (boolean)
 </dd>
 </dl><a NAME="CompleterRuby.__inHereDocument" ID="CompleterRuby.__inHereDocument"></a>
 <h4>CompleterRuby.__inHereDocument</h4>
 <b>__inHereDocument</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#104;&#101;&#114;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.
+        Private method to check, if the cursor is within a here document.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#104;&#101;&#114;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating, if the cursor is inside a here document (boolean)
 </dd>
 </dl><a NAME="CompleterRuby.__inInlineDocument" ID="CompleterRuby.__inInlineDocument"></a>
 <h4>CompleterRuby.__inInlineDocument</h4>
 <b>__inInlineDocument</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97;&#110; &#105;&#110;&#108;&#105;&#110;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.
+        Private method to check, if the cursor is within an inline document.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97;&#110; &#105;&#110;&#108;&#105;&#110;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating, if the cursor is inside an inline document (boolean)
 </dd>
 </dl><a NAME="CompleterRuby.__inSingleQuotedString" ID="CompleterRuby.__inSingleQuotedString"></a>
 <h4>CompleterRuby.__inSingleQuotedString</h4>
 <b>__inSingleQuotedString</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103;.
+        Private method to check, if the cursor is within a single quoted string.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#115;&#105;&#110;&#103;&#108;&#101;
-            &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating, if the cursor is inside a single
+            quoted string (boolean)
 </dd>
 </dl><a NAME="CompleterRuby.charAdded" ID="CompleterRuby.charAdded"></a>
 <h4>CompleterRuby.charAdded</h4>
 <b>charAdded</b>(<i>charNumber</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114;.
+        Public slot called to handle the user entering a character.
 </p><dl>
 <dt><i>charNumber</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+value of the character entered (integer)
 </dd>
 </dl><a NAME="CompleterRuby.readSettings" ID="CompleterRuby.readSettings"></a>
 <h4>CompleterRuby.readSettings</h4>
 <b>readSettings</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#114;&#101;&#114;&#101;&#97;&#100; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.
+        Public slot called to reread the configuration parameters.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />