--- a/src/eric7/Documentation/Source/eric7.DocumentationTools.APIGenerator.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.DocumentationTools.APIGenerator.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DocumentationTools.APIGenerator</h1>
-
<p>
Module implementing the builtin API generator.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#APIGenerator">APIGenerator</a></td>
<td>Class implementing the builtin documentation generator.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="APIGenerator" ID="APIGenerator"></a>
<h2>APIGenerator</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="#APIGenerator.__init__">APIGenerator</a></td>
<td>Constructor</td>
@@ -91,19 +88,20 @@
<td>Public method to generate the base classes information.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="APIGenerator.__init__" ID="APIGenerator.__init__"></a>
<h4>APIGenerator (Constructor)</h4>
<b>APIGenerator</b>(<i>module</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>module</i> (Module)</dt>
@@ -114,10 +112,10 @@
<a NAME="APIGenerator.__addClassVariablesAPI" ID="APIGenerator.__addClassVariablesAPI"></a>
<h4>APIGenerator.__addClassVariablesAPI</h4>
<b>__addClassVariablesAPI</b>(<i>className</i>)
-
<p>
Private method to generate class api section for class variables.
</p>
+
<dl>
<dt><i>className</i> (str)</dt>
@@ -128,31 +126,31 @@
<a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a>
<h4>APIGenerator.__addClassesAPI</h4>
<b>__addClassesAPI</b>(<i></i>)
-
<p>
Private method to generate the api section for classes.
</p>
+
<a NAME="APIGenerator.__addFunctionsAPI" ID="APIGenerator.__addFunctionsAPI"></a>
<h4>APIGenerator.__addFunctionsAPI</h4>
<b>__addFunctionsAPI</b>(<i></i>)
-
<p>
Private method to generate the api section for functions.
</p>
+
<a NAME="APIGenerator.__addGlobalsAPI" ID="APIGenerator.__addGlobalsAPI"></a>
<h4>APIGenerator.__addGlobalsAPI</h4>
<b>__addGlobalsAPI</b>(<i></i>)
-
<p>
Private method to generate the api section for global variables.
</p>
+
<a NAME="APIGenerator.__addMethodsAPI" ID="APIGenerator.__addMethodsAPI"></a>
<h4>APIGenerator.__addMethodsAPI</h4>
<b>__addMethodsAPI</b>(<i>className</i>)
-
<p>
Private method to generate the api section for class methods.
</p>
+
<dl>
<dt><i>className</i> (str)</dt>
@@ -163,10 +161,10 @@
<a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a>
<h4>APIGenerator.__isPrivate</h4>
<b>__isPrivate</b>(<i>obj</i>)
-
<p>
Private method to check, if an object is considered private.
</p>
+
<dl>
<dt><i>obj</i> (ModuleParser.Attribute, ModuleParser.Class or ModuleParser.Function)</dt>
@@ -189,10 +187,10 @@
<a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a>
<h4>APIGenerator.genAPI</h4>
<b>genAPI</b>(<i>basePackage, includePrivate</i>)
-
<p>
Public method to generate the API information.
</p>
+
<dl>
<dt><i>basePackage</i> (str)</dt>
@@ -220,10 +218,10 @@
<a NAME="APIGenerator.genBases" ID="APIGenerator.genBases"></a>
<h4>APIGenerator.genBases</h4>
<b>genBases</b>(<i>includePrivate</i>)
-
<p>
Public method to generate the base classes information.
</p>
+
<dl>
<dt><i>includePrivate</i> (bool)</dt>
@@ -245,4 +243,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
