Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.html	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.html	Tue Dec 19 19:57:08 2023 +0100
@@ -92,39 +92,38 @@
 </p>
 <dl>
 
-<dt><i>htmlDir</i></dt>
+<dt><i>htmlDir</i> (str)</dt>
 <dd>
-directory containing the HTML files (string)
+directory containing the HTML files
 </dd>
-<dt><i>outputDir</i></dt>
+<dt><i>outputDir</i> (str)</dt>
 <dd>
-output directory for the files (string)
+output directory for the files
 </dd>
-<dt><i>namespace</i></dt>
+<dt><i>namespace</i> (str)</dt>
 <dd>
-namespace to be used (string)
+namespace to be used
 </dd>
-<dt><i>virtualFolder</i></dt>
+<dt><i>virtualFolder</i> (str)</dt>
 <dd>
-virtual folder to be used (string)
+virtual folder to be used
 </dd>
-<dt><i>filterName</i></dt>
+<dt><i>filterName</i> (str)</dt>
 <dd>
-name of the custom filter (string)
+name of the custom filter
 </dd>
-<dt><i>filterAttributes</i></dt>
+<dt><i>filterAttributes</i> (str)</dt>
 <dd>
 ':' separated list of filter attributes
-            (string)
 </dd>
-<dt><i>title</i></dt>
+<dt><i>title</i> (str)</dt>
 <dd>
-title to be used for the generated help (string)
+title to be used for the generated help
 </dd>
-<dt><i>createCollection</i></dt>
+<dt><i>createCollection</i> (bool)</dt>
 <dd>
 flag indicating the generation of the
-            collection files (boolean)
+            collection files
 </dd>
 </dl>
 <a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a>
@@ -136,19 +135,25 @@
 </p>
 <dl>
 
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-text to be converted (string)
+text to be converted
 </dd>
-<dt><i>newline</i></dt>
+<dt><i>newline</i> (str)</dt>
 <dd>
-newline character to be used (string)
+newline character to be used
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-converted text (string)
+converted text
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a>
@@ -160,19 +165,25 @@
 </p>
 <dl>
 
-<dt><i>package</i></dt>
+<dt><i>package</i> (str)</dt>
 <dd>
-name of the package to process (string)
+name of the package to process
 </dd>
-<dt><i>level</i></dt>
+<dt><i>level</i> (int)</dt>
 <dd>
-indentation level (integer)
+indentation level
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-sections part (string)
+sections part
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a>
@@ -184,15 +195,15 @@
 </p>
 <dl>
 
-<dt><i>basename</i></dt>
+<dt><i>basename</i> (str)</dt>
 <dd>
-The basename of the file hierarchy to be documented.
-            The basename is stripped off the filename if it starts with
-            the basename.
+base name of the file hierarchy to be documented.
+            The base name is stripped off the filename if it starts with
+            the base name.
 </dd>
-<dt><i>newline</i></dt>
+<dt><i>newline</i> (str)</dt>
 <dd>
-newline character to be used (string)
+newline character to be used
 </dd>
 </dl>
 <a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a>
@@ -204,20 +215,20 @@
 </p>
 <dl>
 
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-The filename to be remembered. (string)
+The filename to be remembered.
 </dd>
-<dt><i>moduleDocument</i></dt>
+<dt><i>moduleDocument</i> (ModuleDocument)</dt>
 <dd>
-The ModuleDocument object containing the
+module documentation object containing the
             information for the file.
 </dd>
-<dt><i>basename</i></dt>
+<dt><i>basename</i> (str)</dt>
 <dd>
-The basename of the file hierarchy to be documented.
-            The basename is stripped off the filename if it starts with
-            the basename.
+base name of the file hierarchy to be documented.
+            The base name is stripped off the filename if it starts with
+            the base name.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>