Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.DocumentationTools.ModuleDocumentor.html	Sun Dec 17 17:15:19 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.DocumentationTools.ModuleDocumentor.html	Mon Dec 18 16:39:01 2023 +0100
@@ -210,15 +210,21 @@
 </p>
 <dl>
 
-<dt><i>descr</i></dt>
+<dt><i>descr</i> (str)</dt>
 <dd>
-documentation string (string)
+documentation string
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the deprecation status (boolean)
+flag indicating the deprecation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a>
@@ -233,15 +239,21 @@
 </p>
 <dl>
 
-<dt><i>entry</i></dt>
+<dt><i>entry</i> (str)</dt>
 <dd>
-the entry to be formatted (string)
+entry to be formatted
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-formatted entry (string)
+formatted entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a>
@@ -253,23 +265,28 @@
 </p>
 <dl>
 
-<dt><i>descr</i></dt>
+<dt><i>descr</i> (str)</dt>
 <dd>
-The contents of the documentation string. (string)
+contents of the documentation string
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-The formatted contents of the documentation string. (string)
+formatted contents of the documentation string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <dl>
 
 <dt>Raises <b>TagError</b>:</dt>
 <dd>
-A tag doesn't have the correct number
-            of arguments.
+A tag doesn't have the correct number of arguments.
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a>
@@ -283,7 +300,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The classes list section. (string)
+classes list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a>
@@ -297,7 +320,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The classes details section. (string)
+classes details section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a>
@@ -309,20 +338,26 @@
 </p>
 <dl>
 
-<dt><i>dictionary</i></dt>
+<dt><i>dictionary</i> (dict)</dt>
 <dd>
-Dictionary containing the info for the
-            list section.
+dictionary containing the info for the
+            list section
 </dd>
-<dt><i>template</i></dt>
+<dt><i>template</i> (str)</dt>
 <dd>
-The template to be used for the list. (string)
+template to be used for the list
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-The list section. (string)
+list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a>
@@ -336,7 +371,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The functions list section. (string)
+functions list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a>
@@ -350,7 +391,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The functions details section. (string)
+functions details section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a>
@@ -363,15 +410,21 @@
 </p>
 <dl>
 
-<dt><i>class_</i></dt>
+<dt><i>class_</i> (class)</dt>
 <dd>
-reference to a class object (Class)
+reference to a class object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-The globals list section. (string)
+globals list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a>
@@ -383,24 +436,29 @@
 </p>
 <dl>
 
-<dt><i>names</i></dt>
+<dt><i>names</i> (list of str)</dt>
 <dd>
-The names to appear in the list. (list of strings)
+names to appear in the list
 </dd>
-<dt><i>sectionDict</i></dt>
+<dt><i>sectionDict</i> (dict)</dt>
 <dd>
 dictionary containing all relevant information
-            (dict)
 </dd>
-<dt><i>kwSuffix</i></dt>
+<dt><i>kwSuffix</i> (str)</dt>
 <dd>
-suffix to be used for the QtHelp keywords (string)
+suffix to be used for the QtHelp keywords
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list section (string)
+list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a>
@@ -412,15 +470,15 @@
 </p>
 <dl>
 
-<dt><i>obj</i></dt>
+<dt><i>obj</i> (class)</dt>
 <dd>
 reference to the object being formatted
 </dd>
-<dt><i>className</i></dt>
+<dt><i>className</i> (str)</dt>
 <dd>
-name of the class containing the method (string)
+name of the class containing the method
 </dd>
-<dt><i>modifierFilter</i></dt>
+<dt><i>modifierFilter</i> (str)</dt>
 <dd>
 filter value designating the method types
 </dd>
@@ -428,7 +486,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-method list and method details section (tuple of two string)
+method list and method details section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a>
@@ -440,33 +504,37 @@
 </p>
 <dl>
 
-<dt><i>names</i></dt>
+<dt><i>names</i> (list of str)</dt>
 <dd>
-names to appear in the list (list of strings)
+names to appear in the list
 </dd>
-<dt><i>sectionDict</i></dt>
+<dt><i>sectionDict</i> (dict)</dt>
 <dd>
 dictionary containing all relevant information
-            (dict)
 </dd>
-<dt><i>className</i></dt>
+<dt><i>className</i> (str)</dt>
 <dd>
 class name containing the names
 </dd>
-<dt><i>clsName</i></dt>
+<dt><i>clsName</i> (str)</dt>
 <dd>
 visible class name containing the names
 </dd>
-<dt><i>includeInit</i></dt>
+<dt><i>includeInit</i> (bool)</dt>
 <dd>
 flag indicating to include the __init__ method
-            (boolean)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-methods list section (string)
+methods list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a>
@@ -479,7 +547,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The body of the document. (string)
+body of the document
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a>
@@ -496,15 +570,21 @@
 </p>
 <dl>
 
-<dt><i>lines</i></dt>
+<dt><i>lines</i> (list of str)</dt>
 <dd>
-A list of individual lines. (list of strings)
+list of individual lines
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-Ready formatted paragraphs. (string)
+formatted paragraphs
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a>
@@ -516,16 +596,22 @@
 </p>
 <dl>
 
-<dt><i>_list</i></dt>
+<dt><i>_list</i> (list of lists with three elements)</dt>
 <dd>
 list containing the info for the parameter description
-            list section (list of lists with three elements)
+            list section
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-formatted list section (string)
+formatted list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a>
@@ -537,25 +623,29 @@
 </p>
 <dl>
 
-<dt><i>names</i></dt>
+<dt><i>names</i> (list of str)</dt>
 <dd>
-The names to appear in the list. (list of strings)
+names to appear in the list
 </dd>
-<dt><i>sectionDict</i></dt>
+<dt><i>sectionDict</i> (dict)</dt>
 <dd>
 dictionary containing all relevant information
-            (dict)
 </dd>
-<dt><i>moduleName</i></dt>
+<dt><i>moduleName</i> (str)</dt>
 <dd>
 name of the Ruby module containing the classes
-            (string)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-The list section. (string)
+list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a>
@@ -567,20 +657,25 @@
 </p>
 <dl>
 
-<dt><i>obj</i></dt>
+<dt><i>obj</i> (class)</dt>
 <dd>
-Reference to the object being formatted.
+reference to the object being formatted
 </dd>
-<dt><i>modName</i></dt>
+<dt><i>modName</i> (str)</dt>
 <dd>
-Name of the Ruby module containing the classes. (string)
+name of the Ruby module containing the classes
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-The classes list and classes details section.
-            (tuple of two string)
+classes list and classes details section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a>
@@ -594,7 +689,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The modules list section. (string)
+modules list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a>
@@ -608,7 +709,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The Ruby modules details section. (string)
+Ruby modules details section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a>
@@ -621,19 +728,25 @@
 </p>
 <dl>
 
-<dt><i>_list</i></dt>
+<dt><i>_list</i> (list)</dt>
 <dd>
-List containing the info for the section.
+list containing the info for the section
 </dd>
-<dt><i>template</i></dt>
+<dt><i>template</i> (str)</dt>
 <dd>
-The template to be used for the list. (string)
+template to be used for the list
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-The list section. (string)
+list section
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a>
@@ -649,15 +762,21 @@
 </p>
 <dl>
 
-<dt><i>desc</i></dt>
+<dt><i>desc</i> (str)</dt>
 <dd>
-The documentation string. (string)
+documentation string
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-The short description. (string)
+short description
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a>
@@ -669,15 +788,21 @@
 </p>
 <dl>
 
-<dt><i>desc</i></dt>
+<dt><i>desc</i> (str)</dt>
 <dd>
-One line of the description (string)
+one line of the description
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-processed line with inline tags expanded (string)
+processed line with inline tags expanded
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <dl>
@@ -697,7 +822,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The description of the module. (string)
+description of the module
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a>
@@ -710,7 +841,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The source code documentation. (string)
+source code documentation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a>
@@ -723,8 +860,14 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of tuples containing the name (string) and the ref
-            (string). The ref is without the filename part.
+list of tuples containing the name and the ref. The ref is without
+            the filename part.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuples of (str, str)
 </dd>
 </dl>
 <a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a>
@@ -738,10 +881,16 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-Flag indicating an empty module (i.e. __init__.py without
+flag indicating an empty module (i.e. __init__.py without
             any contents)
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a>
 <h4>ModuleDocument.name</h4>
 <b>name</b>(<i></i>)
@@ -752,7 +901,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The name of the module. (string)
+name of the module
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a>
@@ -769,7 +924,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-The short description of the module. (string)
+short description of the module
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>