Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.DocumentationTools.APIGenerator.html	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.DocumentationTools.APIGenerator.html	Tue Dec 19 19:57:08 2023 +0100
@@ -106,9 +106,9 @@
 </p>
 <dl>
 
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
 <dd>
-The information of the parsed Python file.
+information of the parsed Python file
 </dd>
 </dl>
 <a NAME="APIGenerator.__addClassVariablesAPI" ID="APIGenerator.__addClassVariablesAPI"></a>
@@ -120,10 +120,9 @@
 </p>
 <dl>
 
-<dt><i>className</i></dt>
+<dt><i>className</i> (str)</dt>
 <dd>
 name of the class containing the class variables
-            (string)
 </dd>
 </dl>
 <a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a>
@@ -156,9 +155,9 @@
 </p>
 <dl>
 
-<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>
 </dl>
 <a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a>
@@ -170,7 +169,7 @@
 </p>
 <dl>
 
-<dt><i>obj</i></dt>
+<dt><i>obj</i> (ModuleParser.Attribute, ModuleParser.Class or ModuleParser.Function)</dt>
 <dd>
 reference to the object to be checked
 </dd>
@@ -178,7 +177,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, that object is considered private (boolean)
+flag indicating, that object is considered private
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a>
@@ -190,20 +195,26 @@
 </p>
 <dl>
 
-<dt><i>basePackage</i></dt>
+<dt><i>basePackage</i> (str)</dt>
 <dd>
-name of the base package (string)
+name of the base package
 </dd>
-<dt><i>includePrivate</i></dt>
+<dt><i>includePrivate</i> (bool)</dt>
 <dd>
 flag indicating to include
-            private methods/functions (boolean)
+            private methods/functions
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-API information (list of strings)
+API information
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="APIGenerator.genBases" ID="APIGenerator.genBases"></a>
@@ -215,16 +226,21 @@
 </p>
 <dl>
 
-<dt><i>includePrivate</i></dt>
+<dt><i>includePrivate</i> (bool)</dt>
 <dd>
 flag indicating to include private classes
-            (boolean)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-base classes information (dictionary of list of strings)
+base classes information
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dictionary of list of str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>