Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.DocumentationTools.IndexGenerator.html	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.DocumentationTools.IndexGenerator.html	Tue Dec 19 19:57:08 2023 +0100
@@ -102,23 +102,29 @@
 </p>
 <dl>
 
-<dt><i>packagename</i></dt>
+<dt><i>packagename</i> (str)</dt>
 <dd>
-The name of the package. (string)
+The name of the package.
 </dd>
-<dt><i>package</i></dt>
+<dt><i>package</i> (dict)</dt>
 <dd>
-A dictionary with information about the package.
+dictionary with information about the package
 </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>
-The name of the generated index file.
+name of the generated index file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a>
@@ -130,20 +136,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
-            information for the file.
+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>
 <a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a>
@@ -155,15 +161,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>
 <div align="right"><a href="#top">Up</a></div>