--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.DocumentationTools.APIGenerator.html	Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,168 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.DocumentationTools.APIGenerator</title>
+<style>
+body {
+    background:white;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+    
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.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>
+object
+<h3>Class Attributes</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>
+<td><a href="#APIGenerator.__addClassVariablesAPI">__addClassVariablesAPI</a></td>
+<td>Private method to generate class api section for class variables.</td>
+</tr><tr>
+<td><a href="#APIGenerator.__addClassesAPI">__addClassesAPI</a></td>
+<td>Private method to generate the api section for classes.</td>
+</tr><tr>
+<td><a href="#APIGenerator.__addFunctionsAPI">__addFunctionsAPI</a></td>
+<td>Private method to generate the api section for functions.</td>
+</tr><tr>
+<td><a href="#APIGenerator.__addGlobalsAPI">__addGlobalsAPI</a></td>
+<td>Private method to generate the api section for global variables.</td>
+</tr><tr>
+<td><a href="#APIGenerator.__addMethodsAPI">__addMethodsAPI</a></td>
+<td>Private method to generate the api section for class methods.</td>
+</tr><tr>
+<td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td>
+<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>
+</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></dt>
+<dd>
+The information of the parsed Python file.
+</dd>
+</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>
+<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>
+<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></dt>
+<dd>
+Name of the class containing the method. (string)
+</dd>
+</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>
+<dt><i>obj</i></dt>
+<dd>
+reference to the object to be checked
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating, that object is considered private (boolean)
+</dd>
+</dl><a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a>
+<h4>APIGenerator.genAPI</h4>
+<b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>)
+<p>
+        Method to generate the source code documentation.
+</p><dl>
+<dt><i>newStyle</i></dt>
+<dd>
+flag indicating the api generation for QScintilla 1.7 and
+            newer (boolean)
+</dd><dt><i>basePackage</i></dt>
+<dd>
+name of the base package (string)
+</dd><dt><i>includePrivate</i></dt>
+<dd>
+flag indicating to include
+            private methods/functions (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+The API information. (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file