Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html

eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.DocumentationTools.ModuleDocumentor</h1> 23 <h1>eric6.DocumentationTools.ModuleDocumentor</h1>
24
23 <p> 25 <p>
24 Module implementing the builtin documentation generator. 26 Module implementing the builtin documentation generator.
25 </p><p> 27 </p>
28 <p>
26 The different parts of the module document are assembled from the parsed 29 The different parts of the module document are assembled from the parsed
27 Python file. The appearance is determined by several templates defined within 30 Python file. The appearance is determined by several templates defined within
28 this module. 31 this module.
29 </p> 32 </p>
30 <h3>Global Attributes</h3> 33 <h3>Global Attributes</h3>
34
31 <table> 35 <table>
32 <tr><td>_event</td></tr><tr><td>_signal</td></tr> 36 <tr><td>_event</td></tr><tr><td>_signal</td></tr>
33 </table> 37 </table>
34 <h3>Classes</h3> 38 <h3>Classes</h3>
35 <table> 39
40 <table>
41
36 <tr> 42 <tr>
37 <td><a href="#ModuleDocument">ModuleDocument</a></td> 43 <td><a href="#ModuleDocument">ModuleDocument</a></td>
38 <td>Class implementing the builtin documentation generator.</td> 44 <td>Class implementing the builtin documentation generator.</td>
39 </tr><tr> 45 </tr>
46 <tr>
40 <td><a href="#TagError">TagError</a></td> 47 <td><a href="#TagError">TagError</a></td>
41 <td>Exception class raised, if an invalid documentation tag was found.</td> 48 <td>Exception class raised, if an invalid documentation tag was found.</td>
42 </tr> 49 </tr>
43 </table> 50 </table>
44 <h3>Functions</h3> 51 <h3>Functions</h3>
52
45 <table> 53 <table>
46 <tr><td>None</td></tr> 54 <tr><td>None</td></tr>
47 </table> 55 </table>
48 <hr /><hr /> 56 <hr />
57 <hr />
49 <a NAME="ModuleDocument" ID="ModuleDocument"></a> 58 <a NAME="ModuleDocument" ID="ModuleDocument"></a>
50 <h2>ModuleDocument</h2> 59 <h2>ModuleDocument</h2>
60
51 <p> 61 <p>
52 Class implementing the builtin documentation generator. 62 Class implementing the builtin documentation generator.
53 </p> 63 </p>
54 <h3>Derived from</h3> 64 <h3>Derived from</h3>
55 object 65 object
56 <h3>Class Attributes</h3> 66 <h3>Class Attributes</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Class Methods</h3> 71 <h3>Class Methods</h3>
72
61 <table> 73 <table>
62 <tr><td>None</td></tr> 74 <tr><td>None</td></tr>
63 </table> 75 </table>
64 <h3>Methods</h3> 76 <h3>Methods</h3>
65 <table> 77
78 <table>
79
66 <tr> 80 <tr>
67 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td> 81 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td>
68 <td>Constructor</td> 82 <td>Constructor</td>
69 </tr><tr> 83 </tr>
84 <tr>
70 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td> 85 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td>
71 <td>Private method to check, if the object to be documented contains a deprecated flag.</td> 86 <td>Private method to check, if the object to be documented contains a deprecated flag.</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td> 89 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td>
74 <td>Private method to format a cross reference entry.</td> 90 <td>Private method to format a cross reference entry.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#ModuleDocument.__formatDescription">__formatDescription</a></td> 93 <td><a href="#ModuleDocument.__formatDescription">__formatDescription</a></td>
77 <td>Private method to format the contents of the documentation string.</td> 94 <td>Private method to format the contents of the documentation string.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#ModuleDocument.__genClassListSection">__genClassListSection</a></td> 97 <td><a href="#ModuleDocument.__genClassListSection">__genClassListSection</a></td>
80 <td>Private method to generate the section listing all classes of the module.</td> 98 <td>Private method to generate the section listing all classes of the module.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#ModuleDocument.__genClassesSection">__genClassesSection</a></td> 101 <td><a href="#ModuleDocument.__genClassesSection">__genClassesSection</a></td>
83 <td>Private method to generate the document section with details about classes.</td> 102 <td>Private method to generate the document section with details about classes.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#ModuleDocument.__genDescriptionListSection">__genDescriptionListSection</a></td> 105 <td><a href="#ModuleDocument.__genDescriptionListSection">__genDescriptionListSection</a></td>
86 <td>Private method to generate the list section of a description.</td> 106 <td>Private method to generate the list section of a description.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#ModuleDocument.__genFunctionListSection">__genFunctionListSection</a></td> 109 <td><a href="#ModuleDocument.__genFunctionListSection">__genFunctionListSection</a></td>
89 <td>Private method to generate the section listing all functions of the module.</td> 110 <td>Private method to generate the section listing all functions of the module.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#ModuleDocument.__genFunctionsSection">__genFunctionsSection</a></td> 113 <td><a href="#ModuleDocument.__genFunctionsSection">__genFunctionsSection</a></td>
92 <td>Private method to generate the document section with details about functions.</td> 114 <td>Private method to generate the document section with details about functions.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#ModuleDocument.__genGlobalsListSection">__genGlobalsListSection</a></td> 117 <td><a href="#ModuleDocument.__genGlobalsListSection">__genGlobalsListSection</a></td>
95 <td>Private method to generate the section listing all global attributes of the module.</td> 118 <td>Private method to generate the section listing all global attributes of the module.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#ModuleDocument.__genListSection">__genListSection</a></td> 121 <td><a href="#ModuleDocument.__genListSection">__genListSection</a></td>
98 <td>Private method to generate a list section of the document.</td> 122 <td>Private method to generate a list section of the document.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#ModuleDocument.__genMethodSection">__genMethodSection</a></td> 125 <td><a href="#ModuleDocument.__genMethodSection">__genMethodSection</a></td>
101 <td>Private method to generate the method details section.</td> 126 <td>Private method to generate the method details section.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#ModuleDocument.__genMethodsListSection">__genMethodsListSection</a></td> 129 <td><a href="#ModuleDocument.__genMethodsListSection">__genMethodsListSection</a></td>
104 <td>Private method to generate the methods list section of a class.</td> 130 <td>Private method to generate the methods list section of a class.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#ModuleDocument.__genModuleSection">__genModuleSection</a></td> 133 <td><a href="#ModuleDocument.__genModuleSection">__genModuleSection</a></td>
107 <td>Private method to generate the body of the document.</td> 134 <td>Private method to generate the body of the document.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#ModuleDocument.__genParagraphs">__genParagraphs</a></td> 137 <td><a href="#ModuleDocument.__genParagraphs">__genParagraphs</a></td>
110 <td>Private method to assemble the descriptive paragraphs of a docstring.</td> 138 <td>Private method to assemble the descriptive paragraphs of a docstring.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#ModuleDocument.__genParamDescriptionListSection">__genParamDescriptionListSection</a></td> 141 <td><a href="#ModuleDocument.__genParamDescriptionListSection">__genParamDescriptionListSection</a></td>
113 <td>Private method to generate the list section of a description.</td> 142 <td>Private method to generate the list section of a description.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#ModuleDocument.__genRbModulesClassesListSection">__genRbModulesClassesListSection</a></td> 145 <td><a href="#ModuleDocument.__genRbModulesClassesListSection">__genRbModulesClassesListSection</a></td>
116 <td>Private method to generate the classes list section of a Ruby module.</td> 146 <td>Private method to generate the classes list section of a Ruby module.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#ModuleDocument.__genRbModulesClassesSection">__genRbModulesClassesSection</a></td> 149 <td><a href="#ModuleDocument.__genRbModulesClassesSection">__genRbModulesClassesSection</a></td>
119 <td>Private method to generate the Ruby module classes details section.</td> 150 <td>Private method to generate the Ruby module classes details section.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#ModuleDocument.__genRbModulesListSection">__genRbModulesListSection</a></td> 153 <td><a href="#ModuleDocument.__genRbModulesListSection">__genRbModulesListSection</a></td>
122 <td>Private method to generate the section listing all modules of the file (Ruby only).</td> 154 <td>Private method to generate the section listing all modules of the file (Ruby only).</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#ModuleDocument.__genRbModulesSection">__genRbModulesSection</a></td> 157 <td><a href="#ModuleDocument.__genRbModulesSection">__genRbModulesSection</a></td>
125 <td>Private method to generate the document section with details about Ruby modules.</td> 158 <td>Private method to generate the document section with details about Ruby modules.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#ModuleDocument.__genSeeListSection">__genSeeListSection</a></td> 161 <td><a href="#ModuleDocument.__genSeeListSection">__genSeeListSection</a></td>
128 <td>Private method to generate the "see also" list section of a description.</td> 162 <td>Private method to generate the "see also" list section of a description.</td>
129 </tr><tr> 163 </tr>
164 <tr>
130 <td><a href="#ModuleDocument.__getShortDescription">__getShortDescription</a></td> 165 <td><a href="#ModuleDocument.__getShortDescription">__getShortDescription</a></td>
131 <td>Private method to determine the short description of an object.</td> 166 <td>Private method to determine the short description of an object.</td>
132 </tr><tr> 167 </tr>
168 <tr>
133 <td><a href="#ModuleDocument.__processInlineTags">__processInlineTags</a></td> 169 <td><a href="#ModuleDocument.__processInlineTags">__processInlineTags</a></td>
134 <td>Private method to process inline tags.</td> 170 <td>Private method to process inline tags.</td>
135 </tr><tr> 171 </tr>
172 <tr>
136 <td><a href="#ModuleDocument.description">description</a></td> 173 <td><a href="#ModuleDocument.description">description</a></td>
137 <td>Public method used to get the description of the module.</td> 174 <td>Public method used to get the description of the module.</td>
138 </tr><tr> 175 </tr>
176 <tr>
139 <td><a href="#ModuleDocument.genDocument">genDocument</a></td> 177 <td><a href="#ModuleDocument.genDocument">genDocument</a></td>
140 <td>Public method to generate the source code documentation.</td> 178 <td>Public method to generate the source code documentation.</td>
141 </tr><tr> 179 </tr>
180 <tr>
142 <td><a href="#ModuleDocument.getQtHelpKeywords">getQtHelpKeywords</a></td> 181 <td><a href="#ModuleDocument.getQtHelpKeywords">getQtHelpKeywords</a></td>
143 <td>Public method to retrieve the parts for the QtHelp keywords section.</td> 182 <td>Public method to retrieve the parts for the QtHelp keywords section.</td>
144 </tr><tr> 183 </tr>
184 <tr>
145 <td><a href="#ModuleDocument.isEmpty">isEmpty</a></td> 185 <td><a href="#ModuleDocument.isEmpty">isEmpty</a></td>
146 <td>Public method to determine, if the module contains any classes or functions.</td> 186 <td>Public method to determine, if the module contains any classes or functions.</td>
147 </tr><tr> 187 </tr>
188 <tr>
148 <td><a href="#ModuleDocument.name">name</a></td> 189 <td><a href="#ModuleDocument.name">name</a></td>
149 <td>Public method used to get the module name.</td> 190 <td>Public method used to get the module name.</td>
150 </tr><tr> 191 </tr>
192 <tr>
151 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td> 193 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td>
152 <td>Public method used to get the short description of the module.</td> 194 <td>Public method used to get the short description of the module.</td>
153 </tr> 195 </tr>
154 </table> 196 </table>
155 <h3>Static Methods</h3> 197 <h3>Static Methods</h3>
198
156 <table> 199 <table>
157 <tr><td>None</td></tr> 200 <tr><td>None</td></tr>
158 </table> 201 </table>
202
159 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> 203 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a>
160 <h4>ModuleDocument (Constructor)</h4> 204 <h4>ModuleDocument (Constructor)</h4>
161 <b>ModuleDocument</b>(<i>module, colors, stylesheet=None</i>) 205 <b>ModuleDocument</b>(<i>module, colors, stylesheet=None</i>)
206
162 <p> 207 <p>
163 Constructor 208 Constructor
164 </p><dl> 209 </p>
210 <dl>
211
165 <dt><i>module</i></dt> 212 <dt><i>module</i></dt>
166 <dd> 213 <dd>
167 the information of the parsed Python file 214 the information of the parsed Python file
168 </dd><dt><i>colors</i></dt> 215 </dd>
216 <dt><i>colors</i></dt>
169 <dd> 217 <dd>
170 dictionary specifying the various colors for the output 218 dictionary specifying the various colors for the output
171 (dictionary of strings) 219 (dictionary of strings)
172 </dd><dt><i>stylesheet</i></dt> 220 </dd>
221 <dt><i>stylesheet</i></dt>
173 <dd> 222 <dd>
174 the style to be used for the generated pages (string) 223 the style to be used for the generated pages (string)
175 </dd> 224 </dd>
176 </dl><a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a> 225 </dl>
226 <a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a>
177 <h4>ModuleDocument.__checkDeprecated</h4> 227 <h4>ModuleDocument.__checkDeprecated</h4>
178 <b>__checkDeprecated</b>(<i>descr</i>) 228 <b>__checkDeprecated</b>(<i>descr</i>)
229
179 <p> 230 <p>
180 Private method to check, if the object to be documented contains a 231 Private method to check, if the object to be documented contains a
181 deprecated flag. 232 deprecated flag.
182 </p><dl> 233 </p>
234 <dl>
235
183 <dt><i>descr</i></dt> 236 <dt><i>descr</i></dt>
184 <dd> 237 <dd>
185 documentation string (string) 238 documentation string (string)
186 </dd> 239 </dd>
187 </dl><dl> 240 </dl>
241 <dl>
188 <dt>Returns:</dt> 242 <dt>Returns:</dt>
189 <dd> 243 <dd>
190 flag indicating the deprecation status (boolean) 244 flag indicating the deprecation status (boolean)
191 </dd> 245 </dd>
192 </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> 246 </dl>
247 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a>
193 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> 248 <h4>ModuleDocument.__formatCrossReferenceEntry</h4>
194 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) 249 <b>__formatCrossReferenceEntry</b>(<i>entry</i>)
250
195 <p> 251 <p>
196 Private method to format a cross reference entry. 252 Private method to format a cross reference entry.
197 </p><p> 253 </p>
254 <p>
198 This cross reference entry looks like "package.module#member label". 255 This cross reference entry looks like "package.module#member label".
199 </p><dl> 256 </p>
257 <dl>
258
200 <dt><i>entry</i></dt> 259 <dt><i>entry</i></dt>
201 <dd> 260 <dd>
202 the entry to be formatted (string) 261 the entry to be formatted (string)
203 </dd> 262 </dd>
204 </dl><dl> 263 </dl>
264 <dl>
205 <dt>Returns:</dt> 265 <dt>Returns:</dt>
206 <dd> 266 <dd>
207 formatted entry (string) 267 formatted entry (string)
208 </dd> 268 </dd>
209 </dl><a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> 269 </dl>
270 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a>
210 <h4>ModuleDocument.__formatDescription</h4> 271 <h4>ModuleDocument.__formatDescription</h4>
211 <b>__formatDescription</b>(<i>descr</i>) 272 <b>__formatDescription</b>(<i>descr</i>)
273
212 <p> 274 <p>
213 Private method to format the contents of the documentation string. 275 Private method to format the contents of the documentation string.
214 </p><dl> 276 </p>
277 <dl>
278
215 <dt><i>descr</i></dt> 279 <dt><i>descr</i></dt>
216 <dd> 280 <dd>
217 The contents of the documentation string. (string) 281 The contents of the documentation string. (string)
218 </dd> 282 </dd>
219 </dl><dl> 283 </dl>
284 <dl>
220 <dt>Returns:</dt> 285 <dt>Returns:</dt>
221 <dd> 286 <dd>
222 The formated contents of the documentation string. (string) 287 The formated contents of the documentation string. (string)
223 </dd> 288 </dd>
224 </dl><dl> 289 </dl>
290 <dl>
291
225 <dt>Raises <b>TagError</b>:</dt> 292 <dt>Raises <b>TagError</b>:</dt>
226 <dd> 293 <dd>
227 A tag doesn't have the correct number 294 A tag doesn't have the correct number
228 of arguments. 295 of arguments.
229 </dd> 296 </dd>
230 </dl><a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> 297 </dl>
298 <a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a>
231 <h4>ModuleDocument.__genClassListSection</h4> 299 <h4>ModuleDocument.__genClassListSection</h4>
232 <b>__genClassListSection</b>(<i></i>) 300 <b>__genClassListSection</b>(<i></i>)
301
233 <p> 302 <p>
234 Private method to generate the section listing all classes of the 303 Private method to generate the section listing all classes of the
235 module. 304 module.
236 </p><dl> 305 </p>
306 <dl>
237 <dt>Returns:</dt> 307 <dt>Returns:</dt>
238 <dd> 308 <dd>
239 The classes list section. (string) 309 The classes list section. (string)
240 </dd> 310 </dd>
241 </dl><a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> 311 </dl>
312 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a>
242 <h4>ModuleDocument.__genClassesSection</h4> 313 <h4>ModuleDocument.__genClassesSection</h4>
243 <b>__genClassesSection</b>(<i></i>) 314 <b>__genClassesSection</b>(<i></i>)
315
244 <p> 316 <p>
245 Private method to generate the document section with details about 317 Private method to generate the document section with details about
246 classes. 318 classes.
247 </p><dl> 319 </p>
320 <dl>
248 <dt>Returns:</dt> 321 <dt>Returns:</dt>
249 <dd> 322 <dd>
250 The classes details section. (string) 323 The classes details section. (string)
251 </dd> 324 </dd>
252 </dl><a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> 325 </dl>
326 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a>
253 <h4>ModuleDocument.__genDescriptionListSection</h4> 327 <h4>ModuleDocument.__genDescriptionListSection</h4>
254 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>) 328 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>)
329
255 <p> 330 <p>
256 Private method to generate the list section of a description. 331 Private method to generate the list section of a description.
257 </p><dl> 332 </p>
333 <dl>
334
258 <dt><i>dictionary</i></dt> 335 <dt><i>dictionary</i></dt>
259 <dd> 336 <dd>
260 Dictionary containing the info for the 337 Dictionary containing the info for the
261 list section. 338 list section.
262 </dd><dt><i>template</i></dt> 339 </dd>
340 <dt><i>template</i></dt>
263 <dd> 341 <dd>
264 The template to be used for the list. (string) 342 The template to be used for the list. (string)
265 </dd> 343 </dd>
266 </dl><dl> 344 </dl>
345 <dl>
267 <dt>Returns:</dt> 346 <dt>Returns:</dt>
268 <dd> 347 <dd>
269 The list section. (string) 348 The list section. (string)
270 </dd> 349 </dd>
271 </dl><a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> 350 </dl>
351 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a>
272 <h4>ModuleDocument.__genFunctionListSection</h4> 352 <h4>ModuleDocument.__genFunctionListSection</h4>
273 <b>__genFunctionListSection</b>(<i></i>) 353 <b>__genFunctionListSection</b>(<i></i>)
354
274 <p> 355 <p>
275 Private method to generate the section listing all functions of the 356 Private method to generate the section listing all functions of the
276 module. 357 module.
277 </p><dl> 358 </p>
359 <dl>
278 <dt>Returns:</dt> 360 <dt>Returns:</dt>
279 <dd> 361 <dd>
280 The functions list section. (string) 362 The functions list section. (string)
281 </dd> 363 </dd>
282 </dl><a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> 364 </dl>
365 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a>
283 <h4>ModuleDocument.__genFunctionsSection</h4> 366 <h4>ModuleDocument.__genFunctionsSection</h4>
284 <b>__genFunctionsSection</b>(<i></i>) 367 <b>__genFunctionsSection</b>(<i></i>)
368
285 <p> 369 <p>
286 Private method to generate the document section with details about 370 Private method to generate the document section with details about
287 functions. 371 functions.
288 </p><dl> 372 </p>
373 <dl>
289 <dt>Returns:</dt> 374 <dt>Returns:</dt>
290 <dd> 375 <dd>
291 The functions details section. (string) 376 The functions details section. (string)
292 </dd> 377 </dd>
293 </dl><a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> 378 </dl>
379 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a>
294 <h4>ModuleDocument.__genGlobalsListSection</h4> 380 <h4>ModuleDocument.__genGlobalsListSection</h4>
295 <b>__genGlobalsListSection</b>(<i>class_=None</i>) 381 <b>__genGlobalsListSection</b>(<i>class_=None</i>)
382
296 <p> 383 <p>
297 Private method to generate the section listing all global attributes of 384 Private method to generate the section listing all global attributes of
298 the module. 385 the module.
299 </p><dl> 386 </p>
387 <dl>
388
300 <dt><i>class_</i></dt> 389 <dt><i>class_</i></dt>
301 <dd> 390 <dd>
302 reference to a class object (Class) 391 reference to a class object (Class)
303 </dd> 392 </dd>
304 </dl><dl> 393 </dl>
394 <dl>
305 <dt>Returns:</dt> 395 <dt>Returns:</dt>
306 <dd> 396 <dd>
307 The globals list section. (string) 397 The globals list section. (string)
308 </dd> 398 </dd>
309 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> 399 </dl>
400 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a>
310 <h4>ModuleDocument.__genListSection</h4> 401 <h4>ModuleDocument.__genListSection</h4>
311 <b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>) 402 <b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>)
403
312 <p> 404 <p>
313 Private method to generate a list section of the document. 405 Private method to generate a list section of the document.
314 </p><dl> 406 </p>
407 <dl>
408
315 <dt><i>names</i></dt> 409 <dt><i>names</i></dt>
316 <dd> 410 <dd>
317 The names to appear in the list. (list of strings) 411 The names to appear in the list. (list of strings)
318 </dd><dt><i>sectionDict</i></dt> 412 </dd>
413 <dt><i>sectionDict</i></dt>
319 <dd> 414 <dd>
320 dictionary containing all relevant information 415 dictionary containing all relevant information
321 (dict) 416 (dict)
322 </dd><dt><i>kwSuffix</i></dt> 417 </dd>
418 <dt><i>kwSuffix</i></dt>
323 <dd> 419 <dd>
324 suffix to be used for the QtHelp keywords (string) 420 suffix to be used for the QtHelp keywords (string)
325 </dd> 421 </dd>
326 </dl><dl> 422 </dl>
423 <dl>
327 <dt>Returns:</dt> 424 <dt>Returns:</dt>
328 <dd> 425 <dd>
329 list section (string) 426 list section (string)
330 </dd> 427 </dd>
331 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> 428 </dl>
429 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a>
332 <h4>ModuleDocument.__genMethodSection</h4> 430 <h4>ModuleDocument.__genMethodSection</h4>
333 <b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>) 431 <b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>)
432
334 <p> 433 <p>
335 Private method to generate the method details section. 434 Private method to generate the method details section.
336 </p><dl> 435 </p>
436 <dl>
437
337 <dt><i>obj</i></dt> 438 <dt><i>obj</i></dt>
338 <dd> 439 <dd>
339 reference to the object being formatted 440 reference to the object being formatted
340 </dd><dt><i>className</i></dt> 441 </dd>
442 <dt><i>className</i></dt>
341 <dd> 443 <dd>
342 name of the class containing the method (string) 444 name of the class containing the method (string)
343 </dd><dt><i>modifierFilter</i></dt> 445 </dd>
446 <dt><i>modifierFilter</i></dt>
344 <dd> 447 <dd>
345 filter value designating the method types 448 filter value designating the method types
346 </dd> 449 </dd>
347 </dl><dl> 450 </dl>
451 <dl>
348 <dt>Returns:</dt> 452 <dt>Returns:</dt>
349 <dd> 453 <dd>
350 method list and method details section (tuple of two string) 454 method list and method details section (tuple of two string)
351 </dd> 455 </dd>
352 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> 456 </dl>
457 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a>
353 <h4>ModuleDocument.__genMethodsListSection</h4> 458 <h4>ModuleDocument.__genMethodsListSection</h4>
354 <b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>) 459 <b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>)
460
355 <p> 461 <p>
356 Private method to generate the methods list section of a class. 462 Private method to generate the methods list section of a class.
357 </p><dl> 463 </p>
464 <dl>
465
358 <dt><i>names</i></dt> 466 <dt><i>names</i></dt>
359 <dd> 467 <dd>
360 names to appear in the list (list of strings) 468 names to appear in the list (list of strings)
361 </dd><dt><i>sectionDict</i></dt> 469 </dd>
470 <dt><i>sectionDict</i></dt>
362 <dd> 471 <dd>
363 dictionary containing all relevant information 472 dictionary containing all relevant information
364 (dict) 473 (dict)
365 </dd><dt><i>className</i></dt> 474 </dd>
475 <dt><i>className</i></dt>
366 <dd> 476 <dd>
367 class name containing the names 477 class name containing the names
368 </dd><dt><i>clsName</i></dt> 478 </dd>
479 <dt><i>clsName</i></dt>
369 <dd> 480 <dd>
370 visible class name containing the names 481 visible class name containing the names
371 </dd><dt><i>includeInit</i></dt> 482 </dd>
483 <dt><i>includeInit</i></dt>
372 <dd> 484 <dd>
373 flag indicating to include the __init__ method 485 flag indicating to include the __init__ method
374 (boolean) 486 (boolean)
375 </dd> 487 </dd>
376 </dl><dl> 488 </dl>
489 <dl>
377 <dt>Returns:</dt> 490 <dt>Returns:</dt>
378 <dd> 491 <dd>
379 methods list section (string) 492 methods list section (string)
380 </dd> 493 </dd>
381 </dl><a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> 494 </dl>
495 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a>
382 <h4>ModuleDocument.__genModuleSection</h4> 496 <h4>ModuleDocument.__genModuleSection</h4>
383 <b>__genModuleSection</b>(<i></i>) 497 <b>__genModuleSection</b>(<i></i>)
498
384 <p> 499 <p>
385 Private method to generate the body of the document. 500 Private method to generate the body of the document.
386 </p><dl> 501 </p>
502 <dl>
387 <dt>Returns:</dt> 503 <dt>Returns:</dt>
388 <dd> 504 <dd>
389 The body of the document. (string) 505 The body of the document. (string)
390 </dd> 506 </dd>
391 </dl><a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> 507 </dl>
508 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a>
392 <h4>ModuleDocument.__genParagraphs</h4> 509 <h4>ModuleDocument.__genParagraphs</h4>
393 <b>__genParagraphs</b>(<i>lines</i>) 510 <b>__genParagraphs</b>(<i>lines</i>)
511
394 <p> 512 <p>
395 Private method to assemble the descriptive paragraphs of a docstring. 513 Private method to assemble the descriptive paragraphs of a docstring.
396 </p><p> 514 </p>
515 <p>
397 A paragraph is made up of a number of consecutive lines without 516 A paragraph is made up of a number of consecutive lines without
398 an intermediate empty line. Empty lines are treated as a paragraph 517 an intermediate empty line. Empty lines are treated as a paragraph
399 delimiter. 518 delimiter.
400 </p><dl> 519 </p>
520 <dl>
521
401 <dt><i>lines</i></dt> 522 <dt><i>lines</i></dt>
402 <dd> 523 <dd>
403 A list of individual lines. (list of strings) 524 A list of individual lines. (list of strings)
404 </dd> 525 </dd>
405 </dl><dl> 526 </dl>
527 <dl>
406 <dt>Returns:</dt> 528 <dt>Returns:</dt>
407 <dd> 529 <dd>
408 Ready formatted paragraphs. (string) 530 Ready formatted paragraphs. (string)
409 </dd> 531 </dd>
410 </dl><a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> 532 </dl>
533 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a>
411 <h4>ModuleDocument.__genParamDescriptionListSection</h4> 534 <h4>ModuleDocument.__genParamDescriptionListSection</h4>
412 <b>__genParamDescriptionListSection</b>(<i>_list</i>) 535 <b>__genParamDescriptionListSection</b>(<i>_list</i>)
536
413 <p> 537 <p>
414 Private method to generate the list section of a description. 538 Private method to generate the list section of a description.
415 </p><dl> 539 </p>
540 <dl>
541
416 <dt><i>_list</i></dt> 542 <dt><i>_list</i></dt>
417 <dd> 543 <dd>
418 list containing the info for the parameter description 544 list containing the info for the parameter description
419 list section (list of lists with three elements) 545 list section (list of lists with three elements)
420 </dd> 546 </dd>
421 </dl><dl> 547 </dl>
548 <dl>
422 <dt>Returns:</dt> 549 <dt>Returns:</dt>
423 <dd> 550 <dd>
424 formatted list section (string) 551 formatted list section (string)
425 </dd> 552 </dd>
426 </dl><a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> 553 </dl>
554 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a>
427 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> 555 <h4>ModuleDocument.__genRbModulesClassesListSection</h4>
428 <b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>) 556 <b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>)
557
429 <p> 558 <p>
430 Private method to generate the classes list section of a Ruby module. 559 Private method to generate the classes list section of a Ruby module.
431 </p><dl> 560 </p>
561 <dl>
562
432 <dt><i>names</i></dt> 563 <dt><i>names</i></dt>
433 <dd> 564 <dd>
434 The names to appear in the list. (list of strings) 565 The names to appear in the list. (list of strings)
435 </dd><dt><i>sectionDict</i></dt> 566 </dd>
567 <dt><i>sectionDict</i></dt>
436 <dd> 568 <dd>
437 dictionary containing all relevant information 569 dictionary containing all relevant information
438 (dict) 570 (dict)
439 </dd><dt><i>moduleName</i></dt> 571 </dd>
572 <dt><i>moduleName</i></dt>
440 <dd> 573 <dd>
441 name of the Ruby module containing the classes 574 name of the Ruby module containing the classes
442 (string) 575 (string)
443 </dd> 576 </dd>
444 </dl><dl> 577 </dl>
578 <dl>
445 <dt>Returns:</dt> 579 <dt>Returns:</dt>
446 <dd> 580 <dd>
447 The list section. (string) 581 The list section. (string)
448 </dd> 582 </dd>
449 </dl><a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> 583 </dl>
584 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a>
450 <h4>ModuleDocument.__genRbModulesClassesSection</h4> 585 <h4>ModuleDocument.__genRbModulesClassesSection</h4>
451 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>) 586 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>)
587
452 <p> 588 <p>
453 Private method to generate the Ruby module classes details section. 589 Private method to generate the Ruby module classes details section.
454 </p><dl> 590 </p>
591 <dl>
592
455 <dt><i>obj</i></dt> 593 <dt><i>obj</i></dt>
456 <dd> 594 <dd>
457 Reference to the object being formatted. 595 Reference to the object being formatted.
458 </dd><dt><i>modName</i></dt> 596 </dd>
597 <dt><i>modName</i></dt>
459 <dd> 598 <dd>
460 Name of the Ruby module containing the classes. (string) 599 Name of the Ruby module containing the classes. (string)
461 </dd> 600 </dd>
462 </dl><dl> 601 </dl>
602 <dl>
463 <dt>Returns:</dt> 603 <dt>Returns:</dt>
464 <dd> 604 <dd>
465 The classes list and classes details section. 605 The classes list and classes details section.
466 (tuple of two string) 606 (tuple of two string)
467 </dd> 607 </dd>
468 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> 608 </dl>
609 <a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a>
469 <h4>ModuleDocument.__genRbModulesListSection</h4> 610 <h4>ModuleDocument.__genRbModulesListSection</h4>
470 <b>__genRbModulesListSection</b>(<i></i>) 611 <b>__genRbModulesListSection</b>(<i></i>)
612
471 <p> 613 <p>
472 Private method to generate the section listing all modules of the file 614 Private method to generate the section listing all modules of the file
473 (Ruby only). 615 (Ruby only).
474 </p><dl> 616 </p>
617 <dl>
475 <dt>Returns:</dt> 618 <dt>Returns:</dt>
476 <dd> 619 <dd>
477 The modules list section. (string) 620 The modules list section. (string)
478 </dd> 621 </dd>
479 </dl><a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> 622 </dl>
623 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a>
480 <h4>ModuleDocument.__genRbModulesSection</h4> 624 <h4>ModuleDocument.__genRbModulesSection</h4>
481 <b>__genRbModulesSection</b>(<i></i>) 625 <b>__genRbModulesSection</b>(<i></i>)
626
482 <p> 627 <p>
483 Private method to generate the document section with details about 628 Private method to generate the document section with details about
484 Ruby modules. 629 Ruby modules.
485 </p><dl> 630 </p>
631 <dl>
486 <dt>Returns:</dt> 632 <dt>Returns:</dt>
487 <dd> 633 <dd>
488 The Ruby modules details section. (string) 634 The Ruby modules details section. (string)
489 </dd> 635 </dd>
490 </dl><a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> 636 </dl>
637 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a>
491 <h4>ModuleDocument.__genSeeListSection</h4> 638 <h4>ModuleDocument.__genSeeListSection</h4>
492 <b>__genSeeListSection</b>(<i>_list, template</i>) 639 <b>__genSeeListSection</b>(<i>_list, template</i>)
640
493 <p> 641 <p>
494 Private method to generate the "see also" list section of a 642 Private method to generate the "see also" list section of a
495 description. 643 description.
496 </p><dl> 644 </p>
645 <dl>
646
497 <dt><i>_list</i></dt> 647 <dt><i>_list</i></dt>
498 <dd> 648 <dd>
499 List containing the info for the section. 649 List containing the info for the section.
500 </dd><dt><i>template</i></dt> 650 </dd>
651 <dt><i>template</i></dt>
501 <dd> 652 <dd>
502 The template to be used for the list. (string) 653 The template to be used for the list. (string)
503 </dd> 654 </dd>
504 </dl><dl> 655 </dl>
656 <dl>
505 <dt>Returns:</dt> 657 <dt>Returns:</dt>
506 <dd> 658 <dd>
507 The list section. (string) 659 The list section. (string)
508 </dd> 660 </dd>
509 </dl><a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> 661 </dl>
662 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a>
510 <h4>ModuleDocument.__getShortDescription</h4> 663 <h4>ModuleDocument.__getShortDescription</h4>
511 <b>__getShortDescription</b>(<i>desc</i>) 664 <b>__getShortDescription</b>(<i>desc</i>)
665
512 <p> 666 <p>
513 Private method to determine the short description of an object. 667 Private method to determine the short description of an object.
514 </p><p> 668 </p>
669 <p>
515 The short description is just the first non empty line of the 670 The short description is just the first non empty line of the
516 documentation string. 671 documentation string.
517 </p><dl> 672 </p>
673 <dl>
674
518 <dt><i>desc</i></dt> 675 <dt><i>desc</i></dt>
519 <dd> 676 <dd>
520 The documentation string. (string) 677 The documentation string. (string)
521 </dd> 678 </dd>
522 </dl><dl> 679 </dl>
680 <dl>
523 <dt>Returns:</dt> 681 <dt>Returns:</dt>
524 <dd> 682 <dd>
525 The short description. (string) 683 The short description. (string)
526 </dd> 684 </dd>
527 </dl><a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> 685 </dl>
686 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a>
528 <h4>ModuleDocument.__processInlineTags</h4> 687 <h4>ModuleDocument.__processInlineTags</h4>
529 <b>__processInlineTags</b>(<i>desc</i>) 688 <b>__processInlineTags</b>(<i>desc</i>)
689
530 <p> 690 <p>
531 Private method to process inline tags. 691 Private method to process inline tags.
532 </p><dl> 692 </p>
693 <dl>
694
533 <dt><i>desc</i></dt> 695 <dt><i>desc</i></dt>
534 <dd> 696 <dd>
535 One line of the description (string) 697 One line of the description (string)
536 </dd> 698 </dd>
537 </dl><dl> 699 </dl>
700 <dl>
538 <dt>Returns:</dt> 701 <dt>Returns:</dt>
539 <dd> 702 <dd>
540 processed line with inline tags expanded (string) 703 processed line with inline tags expanded (string)
541 </dd> 704 </dd>
542 </dl><dl> 705 </dl>
706 <dl>
707
543 <dt>Raises <b>TagError</b>:</dt> 708 <dt>Raises <b>TagError</b>:</dt>
544 <dd> 709 <dd>
545 raised to indicate an invalid tag 710 raised to indicate an invalid tag
546 </dd> 711 </dd>
547 </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a> 712 </dl>
713 <a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a>
548 <h4>ModuleDocument.description</h4> 714 <h4>ModuleDocument.description</h4>
549 <b>description</b>(<i></i>) 715 <b>description</b>(<i></i>)
716
550 <p> 717 <p>
551 Public method used to get the description of the module. 718 Public method used to get the description of the module.
552 </p><dl> 719 </p>
720 <dl>
553 <dt>Returns:</dt> 721 <dt>Returns:</dt>
554 <dd> 722 <dd>
555 The description of the module. (string) 723 The description of the module. (string)
556 </dd> 724 </dd>
557 </dl><a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> 725 </dl>
726 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a>
558 <h4>ModuleDocument.genDocument</h4> 727 <h4>ModuleDocument.genDocument</h4>
559 <b>genDocument</b>(<i></i>) 728 <b>genDocument</b>(<i></i>)
729
560 <p> 730 <p>
561 Public method to generate the source code documentation. 731 Public method to generate the source code documentation.
562 </p><dl> 732 </p>
733 <dl>
563 <dt>Returns:</dt> 734 <dt>Returns:</dt>
564 <dd> 735 <dd>
565 The source code documentation. (string) 736 The source code documentation. (string)
566 </dd> 737 </dd>
567 </dl><a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> 738 </dl>
739 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a>
568 <h4>ModuleDocument.getQtHelpKeywords</h4> 740 <h4>ModuleDocument.getQtHelpKeywords</h4>
569 <b>getQtHelpKeywords</b>(<i></i>) 741 <b>getQtHelpKeywords</b>(<i></i>)
742
570 <p> 743 <p>
571 Public method to retrieve the parts for the QtHelp keywords section. 744 Public method to retrieve the parts for the QtHelp keywords section.
572 </p><dl> 745 </p>
746 <dl>
573 <dt>Returns:</dt> 747 <dt>Returns:</dt>
574 <dd> 748 <dd>
575 list of tuples containing the name (string) and the ref 749 list of tuples containing the name (string) and the ref
576 (string). The ref is without the filename part. 750 (string). The ref is without the filename part.
577 </dd> 751 </dd>
578 </dl><a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> 752 </dl>
753 <a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a>
579 <h4>ModuleDocument.isEmpty</h4> 754 <h4>ModuleDocument.isEmpty</h4>
580 <b>isEmpty</b>(<i></i>) 755 <b>isEmpty</b>(<i></i>)
756
581 <p> 757 <p>
582 Public method to determine, if the module contains any classes or 758 Public method to determine, if the module contains any classes or
583 functions. 759 functions.
584 </p><dl> 760 </p>
761 <dl>
585 <dt>Returns:</dt> 762 <dt>Returns:</dt>
586 <dd> 763 <dd>
587 Flag indicating an empty module (i.e. __init__.py without 764 Flag indicating an empty module (i.e. __init__.py without
588 any contents) 765 any contents)
589 </dd> 766 </dd>
590 </dl><a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a> 767 </dl>
768 <a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a>
591 <h4>ModuleDocument.name</h4> 769 <h4>ModuleDocument.name</h4>
592 <b>name</b>(<i></i>) 770 <b>name</b>(<i></i>)
771
593 <p> 772 <p>
594 Public method used to get the module name. 773 Public method used to get the module name.
595 </p><dl> 774 </p>
775 <dl>
596 <dt>Returns:</dt> 776 <dt>Returns:</dt>
597 <dd> 777 <dd>
598 The name of the module. (string) 778 The name of the module. (string)
599 </dd> 779 </dd>
600 </dl><a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> 780 </dl>
781 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a>
601 <h4>ModuleDocument.shortDescription</h4> 782 <h4>ModuleDocument.shortDescription</h4>
602 <b>shortDescription</b>(<i></i>) 783 <b>shortDescription</b>(<i></i>)
784
603 <p> 785 <p>
604 Public method used to get the short description of the module. 786 Public method used to get the short description of the module.
605 </p><p> 787 </p>
788 <p>
606 The short description is just the first line of the modules 789 The short description is just the first line of the modules
607 description. 790 description.
608 </p><dl> 791 </p>
792 <dl>
609 <dt>Returns:</dt> 793 <dt>Returns:</dt>
610 <dd> 794 <dd>
611 The short description of the module. (string) 795 The short description of the module. (string)
612 </dd> 796 </dd>
613 </dl> 797 </dl>
614 <div align="right"><a href="#top">Up</a></div> 798 <div align="right"><a href="#top">Up</a></div>
615 <hr /><hr /> 799 <hr />
800 <hr />
616 <a NAME="TagError" ID="TagError"></a> 801 <a NAME="TagError" ID="TagError"></a>
617 <h2>TagError</h2> 802 <h2>TagError</h2>
803
618 <p> 804 <p>
619 Exception class raised, if an invalid documentation tag was found. 805 Exception class raised, if an invalid documentation tag was found.
620 </p> 806 </p>
621 <h3>Derived from</h3> 807 <h3>Derived from</h3>
622 Exception 808 Exception
623 <h3>Class Attributes</h3> 809 <h3>Class Attributes</h3>
810
624 <table> 811 <table>
625 <tr><td>None</td></tr> 812 <tr><td>None</td></tr>
626 </table> 813 </table>
627 <h3>Class Methods</h3> 814 <h3>Class Methods</h3>
815
628 <table> 816 <table>
629 <tr><td>None</td></tr> 817 <tr><td>None</td></tr>
630 </table> 818 </table>
631 <h3>Methods</h3> 819 <h3>Methods</h3>
820
632 <table> 821 <table>
633 <tr><td>None</td></tr> 822 <tr><td>None</td></tr>
634 </table> 823 </table>
635 <h3>Static Methods</h3> 824 <h3>Static Methods</h3>
825
636 <table> 826 <table>
637 <tr><td>None</td></tr> 827 <tr><td>None</td></tr>
638 </table> 828 </table>
639 829
640 <div align="right"><a href="#top">Up</a></div> 830 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial