|
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'> |
|
4 <html><head> |
|
5 <title>eric4.DocumentationTools.ModuleDocumentor</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric4.DocumentationTools.ModuleDocumentor</h1> |
|
24 <p> |
|
25 Module implementing the builtin documentation generator. |
|
26 </p><p> |
|
27 The different parts of the module document are assembled from the parsed |
|
28 Python file. The appearance is determined by several templates defined within |
|
29 this module. |
|
30 </p> |
|
31 <h3>Global Attributes</h3> |
|
32 <table> |
|
33 <tr><td>_event</td></tr><tr><td>_signal</td></tr> |
|
34 </table> |
|
35 <h3>Classes</h3> |
|
36 <table> |
|
37 <tr> |
|
38 <td><a href="#ModuleDocument">ModuleDocument</a></td> |
|
39 <td>Class implementing the builtin documentation generator.</td> |
|
40 </tr><tr> |
|
41 <td><a href="#TagError">TagError</a></td> |
|
42 <td>Exception class raised, if an invalid documentation tag was found.</td> |
|
43 </tr> |
|
44 </table> |
|
45 <h3>Functions</h3> |
|
46 <table> |
|
47 <tr><td>None</td></tr> |
|
48 </table> |
|
49 <hr /><hr /> |
|
50 <a NAME="ModuleDocument" ID="ModuleDocument"></a> |
|
51 <h2>ModuleDocument</h2> |
|
52 <p> |
|
53 Class implementing the builtin documentation generator. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 object |
|
57 <h3>Class Attributes</h3> |
|
58 <table> |
|
59 <tr><td>None</td></tr> |
|
60 </table> |
|
61 <h3>Methods</h3> |
|
62 <table> |
|
63 <tr> |
|
64 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td> |
|
65 <td>Constructor</td> |
|
66 </tr><tr> |
|
67 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td> |
|
68 <td>Private method to check, if the object to be documented contains a deprecated flag.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td> |
|
71 <td>Private method to format a cross reference entry.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#ModuleDocument.__formatDescription">__formatDescription</a></td> |
|
74 <td>Private method to format the contents of the documentation string.</td> |
|
75 </tr><tr> |
|
76 <td><a href="#ModuleDocument.__genClassListSection">__genClassListSection</a></td> |
|
77 <td>Private method to generate the section listing all classes of the module.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#ModuleDocument.__genClassesSection">__genClassesSection</a></td> |
|
80 <td>Private method to generate the document section with details about classes.</td> |
|
81 </tr><tr> |
|
82 <td><a href="#ModuleDocument.__genDescriptionListSection">__genDescriptionListSection</a></td> |
|
83 <td>Private method to generate the list section of a description.</td> |
|
84 </tr><tr> |
|
85 <td><a href="#ModuleDocument.__genFunctionListSection">__genFunctionListSection</a></td> |
|
86 <td>Private method to generate the section listing all functions of the module.</td> |
|
87 </tr><tr> |
|
88 <td><a href="#ModuleDocument.__genFunctionsSection">__genFunctionsSection</a></td> |
|
89 <td>Private method to generate the document section with details about functions.</td> |
|
90 </tr><tr> |
|
91 <td><a href="#ModuleDocument.__genGlobalsListSection">__genGlobalsListSection</a></td> |
|
92 <td>Private method to generate the section listing all global attributes of the module.</td> |
|
93 </tr><tr> |
|
94 <td><a href="#ModuleDocument.__genListSection">__genListSection</a></td> |
|
95 <td>Private method to generate a list section of the document.</td> |
|
96 </tr><tr> |
|
97 <td><a href="#ModuleDocument.__genMethodSection">__genMethodSection</a></td> |
|
98 <td>Private method to generate the method details section.</td> |
|
99 </tr><tr> |
|
100 <td><a href="#ModuleDocument.__genMethodsListSection">__genMethodsListSection</a></td> |
|
101 <td>Private method to generate the methods list section of a class.</td> |
|
102 </tr><tr> |
|
103 <td><a href="#ModuleDocument.__genModuleSection">__genModuleSection</a></td> |
|
104 <td>Private method to generate the body of the document.</td> |
|
105 </tr><tr> |
|
106 <td><a href="#ModuleDocument.__genParagraphs">__genParagraphs</a></td> |
|
107 <td>Private method to assemble the descriptive paragraphs of a docstring.</td> |
|
108 </tr><tr> |
|
109 <td><a href="#ModuleDocument.__genParamDescriptionListSection">__genParamDescriptionListSection</a></td> |
|
110 <td>Private method to generate the list section of a description.</td> |
|
111 </tr><tr> |
|
112 <td><a href="#ModuleDocument.__genRbModulesClassesListSection">__genRbModulesClassesListSection</a></td> |
|
113 <td>Private method to generate the classes list section of a Ruby module.</td> |
|
114 </tr><tr> |
|
115 <td><a href="#ModuleDocument.__genRbModulesClassesSection">__genRbModulesClassesSection</a></td> |
|
116 <td>Private method to generate the Ruby module classes details section.</td> |
|
117 </tr><tr> |
|
118 <td><a href="#ModuleDocument.__genRbModulesListSection">__genRbModulesListSection</a></td> |
|
119 <td>Private method to generate the section listing all modules of the file (Ruby only).</td> |
|
120 </tr><tr> |
|
121 <td><a href="#ModuleDocument.__genRbModulesSection">__genRbModulesSection</a></td> |
|
122 <td>Private method to generate the document section with details about Ruby modules.</td> |
|
123 </tr><tr> |
|
124 <td><a href="#ModuleDocument.__genSeeListSection">__genSeeListSection</a></td> |
|
125 <td>Private method to generate the "see also" list section of a description.</td> |
|
126 </tr><tr> |
|
127 <td><a href="#ModuleDocument.__getShortDescription">__getShortDescription</a></td> |
|
128 <td>Private method to determine the short description of an object.</td> |
|
129 </tr><tr> |
|
130 <td><a href="#ModuleDocument.__processInlineTags">__processInlineTags</a></td> |
|
131 <td>Private method to process inline tags.</td> |
|
132 </tr><tr> |
|
133 <td><a href="#ModuleDocument.description">description</a></td> |
|
134 <td>Public method used to get the description of the module.</td> |
|
135 </tr><tr> |
|
136 <td><a href="#ModuleDocument.genDocument">genDocument</a></td> |
|
137 <td>Public method to generate the source code documentation.</td> |
|
138 </tr><tr> |
|
139 <td><a href="#ModuleDocument.getQtHelpKeywords">getQtHelpKeywords</a></td> |
|
140 <td>Public method to retrieve the parts for the QtHelp keywords section.</td> |
|
141 </tr><tr> |
|
142 <td><a href="#ModuleDocument.isEmpty">isEmpty</a></td> |
|
143 <td>Public method to determine, if the module contains any classes or functions.</td> |
|
144 </tr><tr> |
|
145 <td><a href="#ModuleDocument.name">name</a></td> |
|
146 <td>Public method used to get the module name.</td> |
|
147 </tr><tr> |
|
148 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td> |
|
149 <td>Public method used to get the short description of the module.</td> |
|
150 </tr> |
|
151 </table> |
|
152 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> |
|
153 <h4>ModuleDocument (Constructor)</h4> |
|
154 <b>ModuleDocument</b>(<i>module, colors, stylesheet = None</i>) |
|
155 <p> |
|
156 Constructor |
|
157 </p><dl> |
|
158 <dt><i>module</i></dt> |
|
159 <dd> |
|
160 the information of the parsed Python file |
|
161 </dd><dt><i>colors</i></dt> |
|
162 <dd> |
|
163 dictionary specifying the various colors for the output |
|
164 (dictionary of strings) |
|
165 </dd><dt><i>stylesheet</i></dt> |
|
166 <dd> |
|
167 the style to be used for the generated pages (string) |
|
168 </dd> |
|
169 </dl><a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a> |
|
170 <h4>ModuleDocument.__checkDeprecated</h4> |
|
171 <b>__checkDeprecated</b>(<i>descr</i>) |
|
172 <p> |
|
173 Private method to check, if the object to be documented contains a |
|
174 deprecated flag. |
|
175 </p><dl> |
|
176 <dt><i>desc</i></dt> |
|
177 <dd> |
|
178 The documentation string. (string) |
|
179 </dd> |
|
180 </dl><dl> |
|
181 <dt>Returns:</dt> |
|
182 <dd> |
|
183 Flag indicating the deprecation status. (boolean) |
|
184 </dd> |
|
185 </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> |
|
186 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> |
|
187 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) |
|
188 <p> |
|
189 Private method to format a cross reference entry. |
|
190 </p><p> |
|
191 This cross reference entry looks like "package.module#member label". |
|
192 </p><dl> |
|
193 <dt><i>entry</i></dt> |
|
194 <dd> |
|
195 the entry to be formatted (string) |
|
196 </dd> |
|
197 </dl><dl> |
|
198 <dt>Returns:</dt> |
|
199 <dd> |
|
200 formatted entry (string) |
|
201 </dd> |
|
202 </dl><a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> |
|
203 <h4>ModuleDocument.__formatDescription</h4> |
|
204 <b>__formatDescription</b>(<i>descr</i>) |
|
205 <p> |
|
206 Private method to format the contents of the documentation string. |
|
207 </p><dl> |
|
208 <dt><i>descr</i></dt> |
|
209 <dd> |
|
210 The contents of the documentation string. (string) |
|
211 </dd> |
|
212 </dl><dl> |
|
213 <dt>Returns:</dt> |
|
214 <dd> |
|
215 The formated contents of the documentation string. (string) |
|
216 </dd> |
|
217 </dl><dl> |
|
218 <dt>Raises <b>TagError</b>:</dt> |
|
219 <dd> |
|
220 A tag doesn't have the correct number |
|
221 of arguments. |
|
222 </dd> |
|
223 </dl><a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> |
|
224 <h4>ModuleDocument.__genClassListSection</h4> |
|
225 <b>__genClassListSection</b>(<i></i>) |
|
226 <p> |
|
227 Private method to generate the section listing all classes of the module. |
|
228 </p><dl> |
|
229 <dt>Returns:</dt> |
|
230 <dd> |
|
231 The classes list section. (string) |
|
232 </dd> |
|
233 </dl><a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> |
|
234 <h4>ModuleDocument.__genClassesSection</h4> |
|
235 <b>__genClassesSection</b>(<i></i>) |
|
236 <p> |
|
237 Private method to generate the document section with details about classes. |
|
238 </p><dl> |
|
239 <dt>Returns:</dt> |
|
240 <dd> |
|
241 The classes details section. (string) |
|
242 </dd> |
|
243 </dl><a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> |
|
244 <h4>ModuleDocument.__genDescriptionListSection</h4> |
|
245 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>) |
|
246 <p> |
|
247 Private method to generate the list section of a description. |
|
248 </p><dl> |
|
249 <dt><i>dictionary</i></dt> |
|
250 <dd> |
|
251 Dictionary containing the info for the |
|
252 list section. |
|
253 </dd><dt><i>template</i></dt> |
|
254 <dd> |
|
255 The template to be used for the list. (string) |
|
256 </dd> |
|
257 </dl><dl> |
|
258 <dt>Returns:</dt> |
|
259 <dd> |
|
260 The list section. (string) |
|
261 </dd> |
|
262 </dl><a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> |
|
263 <h4>ModuleDocument.__genFunctionListSection</h4> |
|
264 <b>__genFunctionListSection</b>(<i></i>) |
|
265 <p> |
|
266 Private method to generate the section listing all functions of the module. |
|
267 </p><dl> |
|
268 <dt>Returns:</dt> |
|
269 <dd> |
|
270 The functions list section. (string) |
|
271 </dd> |
|
272 </dl><a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> |
|
273 <h4>ModuleDocument.__genFunctionsSection</h4> |
|
274 <b>__genFunctionsSection</b>(<i></i>) |
|
275 <p> |
|
276 Private method to generate the document section with details about functions. |
|
277 </p><dl> |
|
278 <dt>Returns:</dt> |
|
279 <dd> |
|
280 The functions details section. (string) |
|
281 </dd> |
|
282 </dl><a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> |
|
283 <h4>ModuleDocument.__genGlobalsListSection</h4> |
|
284 <b>__genGlobalsListSection</b>(<i>class_ = None</i>) |
|
285 <p> |
|
286 Private method to generate the section listing all global attributes of |
|
287 the module. |
|
288 </p><dl> |
|
289 <dt><i>class_</i></dt> |
|
290 <dd> |
|
291 reference to a class object (Class) |
|
292 </dd> |
|
293 </dl><dl> |
|
294 <dt>Returns:</dt> |
|
295 <dd> |
|
296 The globals list section. (string) |
|
297 </dd> |
|
298 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> |
|
299 <h4>ModuleDocument.__genListSection</h4> |
|
300 <b>__genListSection</b>(<i>names, dict, kwSuffix = ""</i>) |
|
301 <p> |
|
302 Private method to generate a list section of the document. |
|
303 </p><dl> |
|
304 <dt><i>names</i></dt> |
|
305 <dd> |
|
306 The names to appear in the list. (list of strings) |
|
307 </dd><dt><i>dict</i></dt> |
|
308 <dd> |
|
309 A dictionary containing all relevant information. |
|
310 </dd><dt><i>kwSuffix</i></dt> |
|
311 <dd> |
|
312 suffix to be used for the QtHelp keywords (string) |
|
313 </dd> |
|
314 </dl><dl> |
|
315 <dt>Returns:</dt> |
|
316 <dd> |
|
317 The list section. (string) |
|
318 </dd> |
|
319 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> |
|
320 <h4>ModuleDocument.__genMethodSection</h4> |
|
321 <b>__genMethodSection</b>(<i>obj, className</i>) |
|
322 <p> |
|
323 Private method to generate the method details section. |
|
324 </p><dl> |
|
325 <dt><i>obj</i></dt> |
|
326 <dd> |
|
327 Reference to the object being formatted. |
|
328 </dd><dt><i>className</i></dt> |
|
329 <dd> |
|
330 Name of the class containing the method. (string) |
|
331 </dd> |
|
332 </dl><dl> |
|
333 <dt>Returns:</dt> |
|
334 <dd> |
|
335 The method list and method details section. (tuple of two string) |
|
336 </dd> |
|
337 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> |
|
338 <h4>ModuleDocument.__genMethodsListSection</h4> |
|
339 <b>__genMethodsListSection</b>(<i>names, dict, className, clsName</i>) |
|
340 <p> |
|
341 Private method to generate the methods list section of a class. |
|
342 </p><dl> |
|
343 <dt><i>names</i></dt> |
|
344 <dd> |
|
345 The names to appear in the list. (list of strings) |
|
346 </dd><dt><i>dict</i></dt> |
|
347 <dd> |
|
348 A dictionary containing all relevant information. |
|
349 </dd><dt><i>className</i></dt> |
|
350 <dd> |
|
351 The class name containing the names. |
|
352 </dd><dt><i>clsName</i></dt> |
|
353 <dd> |
|
354 The visible class name containing the names. |
|
355 </dd> |
|
356 </dl><dl> |
|
357 <dt>Returns:</dt> |
|
358 <dd> |
|
359 The list section. (string) |
|
360 </dd> |
|
361 </dl><a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> |
|
362 <h4>ModuleDocument.__genModuleSection</h4> |
|
363 <b>__genModuleSection</b>(<i></i>) |
|
364 <p> |
|
365 Private method to generate the body of the document. |
|
366 </p><dl> |
|
367 <dt>Returns:</dt> |
|
368 <dd> |
|
369 The body of the document. (string) |
|
370 </dd> |
|
371 </dl><a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> |
|
372 <h4>ModuleDocument.__genParagraphs</h4> |
|
373 <b>__genParagraphs</b>(<i>lines</i>) |
|
374 <p> |
|
375 Private method to assemble the descriptive paragraphs of a docstring. |
|
376 </p><p> |
|
377 A paragraph is made up of a number of consecutive lines without |
|
378 an intermediate empty line. Empty lines are treated as a paragraph |
|
379 delimiter. |
|
380 </p><dl> |
|
381 <dt><i>lines</i></dt> |
|
382 <dd> |
|
383 A list of individual lines. (list of strings) |
|
384 </dd> |
|
385 </dl><dl> |
|
386 <dt>Returns:</dt> |
|
387 <dd> |
|
388 Ready formatted paragraphs. (string) |
|
389 </dd> |
|
390 </dl><a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> |
|
391 <h4>ModuleDocument.__genParamDescriptionListSection</h4> |
|
392 <b>__genParamDescriptionListSection</b>(<i>_list, template</i>) |
|
393 <p> |
|
394 Private method to generate the list section of a description. |
|
395 </p><dl> |
|
396 <dt><i>_list</i></dt> |
|
397 <dd> |
|
398 List containing the info for the |
|
399 list section. |
|
400 </dd><dt><i>template</i></dt> |
|
401 <dd> |
|
402 The template to be used for the list. (string) |
|
403 </dd> |
|
404 </dl><dl> |
|
405 <dt>Returns:</dt> |
|
406 <dd> |
|
407 The list section. (string) |
|
408 </dd> |
|
409 </dl><a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> |
|
410 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> |
|
411 <b>__genRbModulesClassesListSection</b>(<i>names, dict, moduleName</i>) |
|
412 <p> |
|
413 Private method to generate the classes list section of a Ruby module. |
|
414 </p><dl> |
|
415 <dt><i>names</i></dt> |
|
416 <dd> |
|
417 The names to appear in the list. (list of strings) |
|
418 </dd><dt><i>dict</i></dt> |
|
419 <dd> |
|
420 A dictionary containing all relevant information. |
|
421 </dd><dt><i>moduleName</i></dt> |
|
422 <dd> |
|
423 Name of the Ruby module containing the classes. (string) |
|
424 </dd> |
|
425 </dl><dl> |
|
426 <dt>Returns:</dt> |
|
427 <dd> |
|
428 The list section. (string) |
|
429 </dd> |
|
430 </dl><a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> |
|
431 <h4>ModuleDocument.__genRbModulesClassesSection</h4> |
|
432 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>) |
|
433 <p> |
|
434 Private method to generate the Ruby module classes details section. |
|
435 </p><dl> |
|
436 <dt><i>obj</i></dt> |
|
437 <dd> |
|
438 Reference to the object being formatted. |
|
439 </dd><dt><i>modName</i></dt> |
|
440 <dd> |
|
441 Name of the Ruby module containing the classes. (string) |
|
442 </dd> |
|
443 </dl><dl> |
|
444 <dt>Returns:</dt> |
|
445 <dd> |
|
446 The classes list and classes details section. (tuple of two string) |
|
447 </dd> |
|
448 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> |
|
449 <h4>ModuleDocument.__genRbModulesListSection</h4> |
|
450 <b>__genRbModulesListSection</b>(<i></i>) |
|
451 <p> |
|
452 Private method to generate the section listing all modules of the file |
|
453 (Ruby only). |
|
454 </p><dl> |
|
455 <dt>Returns:</dt> |
|
456 <dd> |
|
457 The modules list section. (string) |
|
458 </dd> |
|
459 </dl><a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> |
|
460 <h4>ModuleDocument.__genRbModulesSection</h4> |
|
461 <b>__genRbModulesSection</b>(<i></i>) |
|
462 <p> |
|
463 Private method to generate the document section with details about Ruby modules. |
|
464 </p><dl> |
|
465 <dt>Returns:</dt> |
|
466 <dd> |
|
467 The Ruby modules details section. (string) |
|
468 </dd> |
|
469 </dl><a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> |
|
470 <h4>ModuleDocument.__genSeeListSection</h4> |
|
471 <b>__genSeeListSection</b>(<i>_list, template</i>) |
|
472 <p> |
|
473 Private method to generate the "see also" list section of a description. |
|
474 </p><dl> |
|
475 <dt><i>_list</i></dt> |
|
476 <dd> |
|
477 List containing the info for the section. |
|
478 </dd><dt><i>template</i></dt> |
|
479 <dd> |
|
480 The template to be used for the list. (string) |
|
481 </dd> |
|
482 </dl><dl> |
|
483 <dt>Returns:</dt> |
|
484 <dd> |
|
485 The list section. (string) |
|
486 </dd> |
|
487 </dl><a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> |
|
488 <h4>ModuleDocument.__getShortDescription</h4> |
|
489 <b>__getShortDescription</b>(<i>desc</i>) |
|
490 <p> |
|
491 Private method to determine the short description of an object. |
|
492 </p><p> |
|
493 The short description is just the first non empty line of the |
|
494 documentation string. |
|
495 </p><dl> |
|
496 <dt><i>desc</i></dt> |
|
497 <dd> |
|
498 The documentation string. (string) |
|
499 </dd> |
|
500 </dl><dl> |
|
501 <dt>Returns:</dt> |
|
502 <dd> |
|
503 The short description. (string) |
|
504 </dd> |
|
505 </dl><a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> |
|
506 <h4>ModuleDocument.__processInlineTags</h4> |
|
507 <b>__processInlineTags</b>(<i>desc</i>) |
|
508 <p> |
|
509 Private method to process inline tags. |
|
510 </p><dl> |
|
511 <dt><i>desc</i></dt> |
|
512 <dd> |
|
513 One line of the description (string) |
|
514 </dd> |
|
515 </dl><dl> |
|
516 <dt>Returns:</dt> |
|
517 <dd> |
|
518 processed line with inline tags expanded (string) |
|
519 </dd> |
|
520 </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a> |
|
521 <h4>ModuleDocument.description</h4> |
|
522 <b>description</b>(<i></i>) |
|
523 <p> |
|
524 Public method used to get the description of the module. |
|
525 </p><dl> |
|
526 <dt>Returns:</dt> |
|
527 <dd> |
|
528 The description of the module. (string) |
|
529 </dd> |
|
530 </dl><a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> |
|
531 <h4>ModuleDocument.genDocument</h4> |
|
532 <b>genDocument</b>(<i></i>) |
|
533 <p> |
|
534 Public method to generate the source code documentation. |
|
535 </p><dl> |
|
536 <dt>Returns:</dt> |
|
537 <dd> |
|
538 The source code documentation. (string) |
|
539 </dd> |
|
540 </dl><a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> |
|
541 <h4>ModuleDocument.getQtHelpKeywords</h4> |
|
542 <b>getQtHelpKeywords</b>(<i></i>) |
|
543 <p> |
|
544 Public method to retrieve the parts for the QtHelp keywords section. |
|
545 </p><dl> |
|
546 <dt>Returns:</dt> |
|
547 <dd> |
|
548 list of tuples containing the name (string) and the ref (string). The ref |
|
549 is without the filename part. |
|
550 </dd> |
|
551 </dl><a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> |
|
552 <h4>ModuleDocument.isEmpty</h4> |
|
553 <b>isEmpty</b>(<i></i>) |
|
554 <p> |
|
555 Public method to determine, if the module contains any classes or functions. |
|
556 </p><dl> |
|
557 <dt>Returns:</dt> |
|
558 <dd> |
|
559 Flag indicating an empty module (i.e. __init__.py without |
|
560 any contents) |
|
561 </dd> |
|
562 </dl><a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a> |
|
563 <h4>ModuleDocument.name</h4> |
|
564 <b>name</b>(<i></i>) |
|
565 <p> |
|
566 Public method used to get the module name. |
|
567 </p><dl> |
|
568 <dt>Returns:</dt> |
|
569 <dd> |
|
570 The name of the module. (string) |
|
571 </dd> |
|
572 </dl><a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> |
|
573 <h4>ModuleDocument.shortDescription</h4> |
|
574 <b>shortDescription</b>(<i></i>) |
|
575 <p> |
|
576 Public method used to get the short description of the module. |
|
577 </p><p> |
|
578 The short description is just the first line of the modules |
|
579 description. |
|
580 </p><dl> |
|
581 <dt>Returns:</dt> |
|
582 <dd> |
|
583 The short description of the module. (string) |
|
584 </dd> |
|
585 </dl> |
|
586 <div align="right"><a href="#top">Up</a></div> |
|
587 <hr /><hr /> |
|
588 <a NAME="TagError" ID="TagError"></a> |
|
589 <h2>TagError</h2> |
|
590 <p> |
|
591 Exception class raised, if an invalid documentation tag was found. |
|
592 </p> |
|
593 <h3>Derived from</h3> |
|
594 Exception |
|
595 <h3>Class Attributes</h3> |
|
596 <table> |
|
597 <tr><td>None</td></tr> |
|
598 </table> |
|
599 <h3>Methods</h3> |
|
600 <table> |
|
601 <tr><td>None</td></tr> |
|
602 </table> |
|
603 |
|
604 <div align="right"><a href="#top">Up</a></div> |
|
605 <hr /> |
|
606 </body></html> |