1
<?xml version="1.0" encoding="utf-8"?>
2
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
5
<title>eric4.DocumentationTools.APIGenerator</title>
9
margin: 0em 1em 10em 1em;
13
h1 { color: white; background: #4FA4FF; }
14
h2 { color: white; background: #4FA4FF; }
15
h3 { color: white; background: #00557F; }
16
h4 { color: white; background: #00557F; }
22
<body><a NAME="top" ID="top"></a>
23
<h1>eric4.DocumentationTools.APIGenerator</h1>
25
Module implementing the builtin API generator.
30
<td><a href="#APIGenerator">APIGenerator</a></td>
31
<td>Class implementing the builtin documentation generator.</td>
36
<tr><td>None</td></tr>
39
<a NAME="APIGenerator" ID="APIGenerator"></a>
42
Class implementing the builtin documentation generator.
49
<td><a href="#APIGenerator.__init__">APIGenerator</a></td>
52
<td><a href="#APIGenerator.__addClassesAPI">__addClassesAPI</a></td>
53
<td>Private method to generate the document section with details about classes.</td>
55
<td><a href="#APIGenerator.__addFunctionsAPI">__addFunctionsAPI</a></td>
56
<td>Private method to generate the document section with details about functions.</td>
58
<td><a href="#APIGenerator.__addMethodsAPI">__addMethodsAPI</a></td>
59
<td>Private method to generate the method details section.</td>
61
<td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td>
62
<td>Private method to check, if a name is considered private.</td>
64
<td><a href="#APIGenerator.genAPI">genAPI</a></td>
65
<td>Method to generate the source code documentation.</td>
68
<p><a NAME="APIGenerator.__init__" ID="APIGenerator.__init__"></a>
69
<h4>APIGenerator (Constructor)</h4>
70
<b>APIGenerator</b>(<i>module</i>)
74
<dt><i>module</i></dt>
76
The information of the parsed Python file.
78
</dl><a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a>
79
<h4>APIGenerator.__addClassesAPI</h4>
80
<b>__addClassesAPI</b>(<i></i>)
82
Private method to generate the document section with details about classes.
86
The classes details section. (string)
88
</dl><a NAME="APIGenerator.__addFunctionsAPI" ID="APIGenerator.__addFunctionsAPI"></a>
89
<h4>APIGenerator.__addFunctionsAPI</h4>
90
<b>__addFunctionsAPI</b>(<i></i>)
92
Private method to generate the document section with details about functions.
96
The functions details section. (string)
98
</dl><a NAME="APIGenerator.__addMethodsAPI" ID="APIGenerator.__addMethodsAPI"></a>
99
<h4>APIGenerator.__addMethodsAPI</h4>
100
<b>__addMethodsAPI</b>(<i>className</i>)
102
Private method to generate the method details section.
104
<dt><i>classname</i></dt>
106
Name of the class containing the method. (string)
111
The method details section. (string)
113
</dl><a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a>
114
<h4>APIGenerator.__isPrivate</h4>
115
<b>__isPrivate</b>(<i>name</i>)
117
Private method to check, if a name is considered private.
121
flag indicating a name, that is considered private (boolean)
123
</dl><a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a>
124
<h4>APIGenerator.genAPI</h4>
125
<b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>)
127
Method to generate the source code documentation.
129
<dt><i>newStyle</i></dt>
131
flag indicating the api generation for QScintilla 1.7 and
133
</dd><dt><i>basePackage</i></dt>
135
name of the base package (string)
136
</dd><dt><i>includePrivate</i></dt>
138
flag indicating to include
139
private methods/functions (boolean)
144
The API information. (string)
147
<div align="right"><a href="#top">Up</a></div>
b'\\ No newline at end of file'
added
removed
eric/Documentation/Source/eric4.DocumentationTools.APIGenerator.html
