Documentation/Source/eric5.DocumentationTools.APIGenerator.html

changeset 1342
30226d5a7ffb
parent 1229
a8207dc73672
child 2367
78f6c8193d37
--- a/Documentation/Source/eric5.DocumentationTools.APIGenerator.html	Tue Sep 27 19:03:52 2011 +0200
+++ b/Documentation/Source/eric5.DocumentationTools.APIGenerator.html	Fri Sep 30 19:08:38 2011 +0200
@@ -80,7 +80,10 @@
 <td>Private method to check, if an object is considered private.</td>
 </tr><tr>
 <td><a href="#APIGenerator.genAPI">genAPI</a></td>
-<td>Method to generate the source code documentation.</td>
+<td>Public method to generate the API information.</td>
+</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>
@@ -151,7 +154,7 @@
 <h4>APIGenerator.genAPI</h4>
 <b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>)
 <p>
-        Method to generate the source code documentation.
+        Public method to generate the API information.
 </p><dl>
 <dt><i>newStyle</i></dt>
 <dd>
@@ -168,7 +171,22 @@
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-The API information. (string)
+API information (list of strings)
+</dd>
+</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>
+<dt><i>includePrivate</i></dt>
+<dd>
+flag indicating to include private classes (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+base classes information (dictionary of list of strings)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial