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