--- a/Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.DocumentationTools.QtHelpGenerator</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.
+Module implementing the QtHelp generator for the builtin documentation generator.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.</td>
+<td>Class implementing the QtHelp generator for the builtin documentation generator.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a>
 <h2>QtHelpGenerator</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.
+    Class implementing the QtHelp generator for the builtin documentation generator.
 </p>
 <h3>Derived from</h3>
 object
@@ -55,111 +55,111 @@
 <table>
 <tr>
 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#QtHelpGenerator.__generateKeywords">__generateKeywords</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#107;&#101;yw&#111;&#114;&#100;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;.</td>
+<td>Private method to generate the keywords section.</td>
 </tr><tr>
 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110;&#115; &#112;&#97;&#114;&#116;.</td>
+<td>Private method to generate the sections part.</td>
 </tr><tr>
 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#108;&#108; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;&#115;.</td>
+<td>Public method to generate all index files.</td>
 </tr><tr>
 <td><a href="#QtHelpGenerator.remember">remember</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to remember a documentation file.</td>
 </tr>
 </table>
 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a>
 <h4>QtHelpGenerator (Constructor)</h4>
 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>htmlDir</i></dt>
 <dd>
-&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#72;&#84;&#77;&#76; &#102;&#105;&#108;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+directory containing the HTML files (string)
 </dd><dt><i>outputDir</i></dt>
 <dd>
-&#111;&#117;&#116;&#112;&#117;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+output directory for the files (string)
 </dd><dt><i>namespace</i></dt>
 <dd>
-&#110;&#97;&#109;&#101;&#115;&#112;&#97;&#99;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+namespace to be used (string)
 </dd><dt><i>virtualFolder</i></dt>
 <dd>
-v&#105;&#114;&#116;&#117;&#97;&#108; &#102;&#111;&#108;&#100;&#101;&#114; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+virtual folder to be used (string)
 </dd><dt><i>filterName</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#117;&#115;&#116;&#111;&#109; &#102;&#105;&#108;&#116;&#101;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the custom filter (string)
 </dd><dt><i>filterAttributes</i></dt>
 <dd>
-'&#58;' &#115;&#101;&#112;&#97;&#114;&#97;&#116;&#101;&#100; &#108;&#105;&#115;&#116; &#111;&#102; &#102;&#105;&#108;&#116;&#101;&#114; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+':' separated list of filter attributes (string)
 </dd><dt><i>title</i></dt>
 <dd>
-&#116;&#105;&#116;&#108;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#104;&#101;&#108;&#112; (&#115;&#116;&#114;&#105;&#110;&#103;)
+title to be used for the generated help (string)
 </dd><dt><i>createCollection</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#108;&#108;&#101;&#99;&#116;&#105;&#111;&#110;
-            &#102;&#105;&#108;&#101;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the generation of the collection
+            files (boolean)
 </dd>
 </dl><a NAME="QtHelpGenerator.__generateKeywords" ID="QtHelpGenerator.__generateKeywords"></a>
 <h4>QtHelpGenerator.__generateKeywords</h4>
 <b>__generateKeywords</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#107;&#101;yw&#111;&#114;&#100;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;.
+        Private method to generate the keywords section.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#107;&#101;yw&#111;&#114;&#100;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+keywords section (string)
 </dd>
 </dl><a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a>
 <h4>QtHelpGenerator.__generateSections</h4>
 <b>__generateSections</b>(<i>package, level</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110;&#115; &#112;&#97;&#114;&#116;.
+        Private method to generate the sections part.
 </p><dl>
 <dt><i>package</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101; &#116;&#111; &#112;&#114;&#111;&#99;&#101;&#115;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the package to process (string)
 </dd><dt><i>level</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#101;&#99;&#116;&#105;&#111;&#110;&#115; &#112;&#97;&#114;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+sections part (string)
 </dd>
 </dl><a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a>
 <h4>QtHelpGenerator.generateFiles</h4>
 <b>generateFiles</b>(<i>basename = ""</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#108;&#108; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;&#115;.
+        Public method to generate all index files.
 </p><dl>
 <dt><i>basename</i></dt>
 <dd>
-&#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#104;&#105;&#101;&#114;&#97;&#114;&#99;&#104;y &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100;.
-            &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#105;&#115; &#115;&#116;&#114;&#105;&#112;&#112;&#101;&#100; &#111;&#102;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#102; &#105;&#116; &#115;&#116;&#97;&#114;&#116;&#115; w&#105;&#116;&#104;
-            &#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101;.
+The basename of the file hierarchy to be documented.
+            The basename is stripped off the filename if it starts with
+            the basename.
 </dd>
 </dl><a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a>
 <h4>QtHelpGenerator.remember</h4>
 <b>remember</b>(<i>file, moduleDocument, basename=""</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101;.
+        Public method to remember a documentation file.
 </p><dl>
 <dt><i>file</i></dt>
 <dd>
-&#84;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114;&#101;&#100;. (&#115;&#116;&#114;&#105;&#110;&#103;)
+The filename to be remembered. (string)
 </dd><dt><i>moduleDocument</i></dt>
 <dd>
-&#84;&#104;&#101; &#77;&#111;&#100;&#117;&#108;&#101;&#68;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101;
-            &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
+The ModuleDocument object containing the
+            information for the file.
 </dd><dt><i>basename</i></dt>
 <dd>
-&#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#104;&#105;&#101;&#114;&#97;&#114;&#99;&#104;y &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100;.
-            &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#105;&#115; &#115;&#116;&#114;&#105;&#112;&#112;&#101;&#100; &#111;&#102;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#102; &#105;&#116; &#115;&#116;&#97;&#114;&#116;&#115; w&#105;&#116;&#104;
-            &#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101;.
+The basename of the file hierarchy to be documented.
+            The basename is stripped off the filename if it starts with
+            the basename.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>