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