--- a/src/eric7/Documentation/Source/eric7.DocumentationTools.ModuleDocumentor.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.DocumentationTools.ModuleDocumentor.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,7 +7,6 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DocumentationTools.ModuleDocumentor</h1>
-
<p>
Module implementing the builtin documentation generator.
</p>
@@ -16,15 +15,15 @@
Python file. The appearance is determined by several templates defined within
this module.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>_event</td></tr><tr><td>_signal</td></tr>
+<tr><td>_event</td></tr>
+<tr><td>_signal</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#ModuleDocument">ModuleDocument</a></td>
<td>Class implementing the builtin documentation generator.</td>
@@ -34,35 +33,34 @@
<td>Exception class raised, if an invalid documentation tag was found.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="ModuleDocument" ID="ModuleDocument"></a>
<h2>ModuleDocument</h2>
-
<p>
Class implementing the builtin documentation generator.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#ModuleDocument.__init__">ModuleDocument</a></td>
<td>Constructor</td>
@@ -180,19 +178,20 @@
<td>Public method used to get the short description of the module.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a>
<h4>ModuleDocument (Constructor)</h4>
<b>ModuleDocument</b>(<i>module</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>module</i> (str)</dt>
@@ -203,11 +202,11 @@
<a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a>
<h4>ModuleDocument.__checkDeprecated</h4>
<b>__checkDeprecated</b>(<i>descr</i>)
-
<p>
Private method to check, if the object to be documented contains a
deprecated flag.
</p>
+
<dl>
<dt><i>descr</i> (str)</dt>
@@ -230,13 +229,13 @@
<a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a>
<h4>ModuleDocument.__formatCrossReferenceEntry</h4>
<b>__formatCrossReferenceEntry</b>(<i>entry</i>)
-
<p>
Private method to format a cross reference entry.
</p>
<p>
This cross reference entry looks like "package.module#member label".
</p>
+
<dl>
<dt><i>entry</i> (str)</dt>
@@ -259,10 +258,10 @@
<a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a>
<h4>ModuleDocument.__formatDescription</h4>
<b>__formatDescription</b>(<i>descr</i>)
-
<p>
Private method to format the contents of the documentation string.
</p>
+
<dl>
<dt><i>descr</i> (str)</dt>
@@ -292,11 +291,11 @@
<a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a>
<h4>ModuleDocument.__genClassListSection</h4>
<b>__genClassListSection</b>(<i></i>)
-
<p>
Private method to generate the section listing all classes of the
module.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -312,11 +311,11 @@
<a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a>
<h4>ModuleDocument.__genClassesSection</h4>
<b>__genClassesSection</b>(<i></i>)
-
<p>
Private method to generate the document section with details about
classes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -332,10 +331,10 @@
<a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a>
<h4>ModuleDocument.__genDescriptionListSection</h4>
<b>__genDescriptionListSection</b>(<i>dictionary, template</i>)
-
<p>
Private method to generate the list section of a description.
</p>
+
<dl>
<dt><i>dictionary</i> (dict)</dt>
@@ -363,11 +362,11 @@
<a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a>
<h4>ModuleDocument.__genFunctionListSection</h4>
<b>__genFunctionListSection</b>(<i></i>)
-
<p>
Private method to generate the section listing all functions of the
module.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -383,11 +382,11 @@
<a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a>
<h4>ModuleDocument.__genFunctionsSection</h4>
<b>__genFunctionsSection</b>(<i></i>)
-
<p>
Private method to generate the document section with details about
functions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -403,11 +402,11 @@
<a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a>
<h4>ModuleDocument.__genGlobalsListSection</h4>
<b>__genGlobalsListSection</b>(<i>class_=None</i>)
-
<p>
Private method to generate the section listing all global attributes of
the module.
</p>
+
<dl>
<dt><i>class_</i> (class)</dt>
@@ -430,10 +429,10 @@
<a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a>
<h4>ModuleDocument.__genListSection</h4>
<b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>)
-
<p>
Private method to generate a list section of the document.
</p>
+
<dl>
<dt><i>names</i> (list of str)</dt>
@@ -464,10 +463,10 @@
<a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a>
<h4>ModuleDocument.__genMethodSection</h4>
<b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>)
-
<p>
Private method to generate the method details section.
</p>
+
<dl>
<dt><i>obj</i> (class)</dt>
@@ -498,10 +497,10 @@
<a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a>
<h4>ModuleDocument.__genMethodsListSection</h4>
<b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>)
-
<p>
Private method to generate the methods list section of a class.
</p>
+
<dl>
<dt><i>names</i> (list of str)</dt>
@@ -540,10 +539,10 @@
<a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a>
<h4>ModuleDocument.__genModuleSection</h4>
<b>__genModuleSection</b>(<i></i>)
-
<p>
Private method to generate the body of the document.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -559,7 +558,6 @@
<a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a>
<h4>ModuleDocument.__genParagraphs</h4>
<b>__genParagraphs</b>(<i>lines</i>)
-
<p>
Private method to assemble the descriptive paragraphs of a docstring.
</p>
@@ -568,6 +566,7 @@
an intermediate empty line. Empty lines are treated as a paragraph
delimiter.
</p>
+
<dl>
<dt><i>lines</i> (list of str)</dt>
@@ -590,10 +589,10 @@
<a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a>
<h4>ModuleDocument.__genParamDescriptionListSection</h4>
<b>__genParamDescriptionListSection</b>(<i>_list</i>)
-
<p>
Private method to generate the list section of a description.
</p>
+
<dl>
<dt><i>_list</i> (list of lists with three elements)</dt>
@@ -617,10 +616,10 @@
<a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a>
<h4>ModuleDocument.__genRbModulesClassesListSection</h4>
<b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>)
-
<p>
Private method to generate the classes list section of a Ruby module.
</p>
+
<dl>
<dt><i>names</i> (list of str)</dt>
@@ -651,10 +650,10 @@
<a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a>
<h4>ModuleDocument.__genRbModulesClassesSection</h4>
<b>__genRbModulesClassesSection</b>(<i>obj, modName</i>)
-
<p>
Private method to generate the Ruby module classes details section.
</p>
+
<dl>
<dt><i>obj</i> (class)</dt>
@@ -681,11 +680,11 @@
<a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a>
<h4>ModuleDocument.__genRbModulesListSection</h4>
<b>__genRbModulesListSection</b>(<i></i>)
-
<p>
Private method to generate the section listing all modules of the file
(Ruby only).
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -701,11 +700,11 @@
<a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a>
<h4>ModuleDocument.__genRbModulesSection</h4>
<b>__genRbModulesSection</b>(<i></i>)
-
<p>
Private method to generate the document section with details about
Ruby modules.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -721,11 +720,11 @@
<a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a>
<h4>ModuleDocument.__genSeeListSection</h4>
<b>__genSeeListSection</b>(<i>_list, template</i>)
-
<p>
Private method to generate the "see also" list section of a
description.
</p>
+
<dl>
<dt><i>_list</i> (list)</dt>
@@ -752,7 +751,6 @@
<a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a>
<h4>ModuleDocument.__getShortDescription</h4>
<b>__getShortDescription</b>(<i>desc</i>)
-
<p>
Private method to determine the short description of an object.
</p>
@@ -760,6 +758,7 @@
The short description is just the first non empty line of the
documentation string.
</p>
+
<dl>
<dt><i>desc</i> (str)</dt>
@@ -782,10 +781,10 @@
<a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a>
<h4>ModuleDocument.__processInlineTags</h4>
<b>__processInlineTags</b>(<i>desc</i>)
-
<p>
Private method to process inline tags.
</p>
+
<dl>
<dt><i>desc</i> (str)</dt>
@@ -815,10 +814,10 @@
<a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a>
<h4>ModuleDocument.description</h4>
<b>description</b>(<i></i>)
-
<p>
Public method used to get the description of the module.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -834,10 +833,10 @@
<a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a>
<h4>ModuleDocument.genDocument</h4>
<b>genDocument</b>(<i></i>)
-
<p>
Public method to generate the source code documentation.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -853,10 +852,10 @@
<a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a>
<h4>ModuleDocument.getQtHelpKeywords</h4>
<b>getQtHelpKeywords</b>(<i></i>)
-
<p>
Public method to retrieve the parts for the QtHelp keywords section.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -873,11 +872,11 @@
<a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a>
<h4>ModuleDocument.isEmpty</h4>
<b>isEmpty</b>(<i></i>)
-
<p>
Public method to determine, if the module contains any classes or
functions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -894,10 +893,10 @@
<a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a>
<h4>ModuleDocument.name</h4>
<b>name</b>(<i></i>)
-
<p>
Public method used to get the module name.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -913,7 +912,6 @@
<a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a>
<h4>ModuleDocument.shortDescription</h4>
<b>shortDescription</b>(<i></i>)
-
<p>
Public method used to get the short description of the module.
</p>
@@ -921,6 +919,7 @@
The short description is just the first line of the modules
description.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -938,33 +937,33 @@
<hr />
<a NAME="TagError" ID="TagError"></a>
<h2>TagError</h2>
-
<p>
Exception class raised, if an invalid documentation tag was found.
</p>
+
<h3>Derived from</h3>
Exception
<h3>Class Attributes</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Class Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
