Mercurial Repositories > eric / file diff

diff: eric6/Documentation/Source/eric6.DocumentationTools.APIGenerator.html

eric6/Documentation/Source/eric6.DocumentationTools.APIGenerator.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.DocumentationTools.APIGenerator.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.DocumentationTools.APIGenerator.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,173 +18,229 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.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 />
+<hr />
+<hr />
 <a NAME="APIGenerator" ID="APIGenerator"></a>
 <h2>APIGenerator</h2>
+
 <p>
     Class implementing the builtin documentation generator.
 </p>
 <h3>Derived from</h3>
 object
 <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>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#APIGenerator.__addClassVariablesAPI">__addClassVariablesAPI</a></td>
 <td>Private method to generate class api section for class variables.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#APIGenerator.__addClassesAPI">__addClassesAPI</a></td>
 <td>Private method to generate the api section for classes.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#APIGenerator.__addFunctionsAPI">__addFunctionsAPI</a></td>
 <td>Private method to generate the api section for functions.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#APIGenerator.__addGlobalsAPI">__addGlobalsAPI</a></td>
 <td>Private method to generate the api section for global variables.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#APIGenerator.__addMethodsAPI">__addMethodsAPI</a></td>
 <td>Private method to generate the api section for class methods.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td>
 <td>Private method to check, if an object is considered private.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#APIGenerator.genAPI">genAPI</a></td>
 <td>Public method to generate the API information.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#APIGenerator.genBases">genBases</a></td>
 <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>
+</p>
+<dl>
+
 <dt><i>module</i></dt>
 <dd>
 The information of the parsed Python file.
 </dd>
-</dl><a NAME="APIGenerator.__addClassVariablesAPI" ID="APIGenerator.__addClassVariablesAPI"></a>
+</dl>
+<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>
+</p>
+<dl>
+
 <dt><i>className</i></dt>
 <dd>
 name of the class containing the class variables
             (string)
 </dd>
-</dl><a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a>
+</dl>
+<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>
+</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>
+</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>
+</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>
+</p>
+<dl>
+
 <dt><i>className</i></dt>
 <dd>
 name of the class containing the method (string)
 </dd>
-</dl><a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a>
+</dl>
+<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>
+</p>
+<dl>
+
 <dt><i>obj</i></dt>
 <dd>
 reference to the object to be checked
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating, that object is considered private (boolean)
 </dd>
-</dl><a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a>
+</dl>
+<a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a>
 <h4>APIGenerator.genAPI</h4>
 <b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>)
+
 <p>
         Public method to generate the API information.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>newStyle</i></dt>
 <dd>
 flag indicating the api generation for QScintilla 1.7
             and newer (boolean) (ignored)
-</dd><dt><i>basePackage</i></dt>
+</dd>
+<dt><i>basePackage</i></dt>
 <dd>
 name of the base package (string)
-</dd><dt><i>includePrivate</i></dt>
+</dd>
+<dt><i>includePrivate</i></dt>
 <dd>
 flag indicating to include
             private methods/functions (boolean)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 API information (list of strings)
 </dd>
-</dl><a NAME="APIGenerator.genBases" ID="APIGenerator.genBases"></a>
+</dl>
+<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>
+</p>
+<dl>
+
 <dt><i>includePrivate</i></dt>
 <dd>
 flag indicating to include private classes
             (boolean)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 base classes information (dictionary of list of strings)

Mercurial Repository: eric

eric ide

mercurial