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 10479
- 856476537696
- parent 10418
- 4573827e9815
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.DocumentationTools.ModuleDocumentor</h1> | 9 <h1>eric7.DocumentationTools.ModuleDocumentor</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the builtin documentation generator. | 11 Module implementing the builtin documentation generator. |
| 13 </p> | 12 </p> |
| 14 <p> | 13 <p> |
| 15 The different parts of the module document are assembled from the parsed | 14 The different parts of the module document are assembled from the parsed |
| 16 Python file. The appearance is determined by several templates defined within | 15 Python file. The appearance is determined by several templates defined within |
| 17 this module. | 16 this module. |
| 18 </p> | 17 </p> |
| 18 | |
| 19 <h3>Global Attributes</h3> | 19 <h3>Global Attributes</h3> |
| 20 | 20 <table> |
| 21 <table> | 21 <tr><td>_event</td></tr> |
| 22 <tr><td>_event</td></tr><tr><td>_signal</td></tr> | 22 <tr><td>_signal</td></tr> |
| 23 </table> | 23 </table> |
| 24 | |
| 24 <h3>Classes</h3> | 25 <h3>Classes</h3> |
| 25 | 26 <table> |
| 26 <table> | |
| 27 | |
| 28 <tr> | 27 <tr> |
| 29 <td><a href="#ModuleDocument">ModuleDocument</a></td> | 28 <td><a href="#ModuleDocument">ModuleDocument</a></td> |
| 30 <td>Class implementing the builtin documentation generator.</td> | 29 <td>Class implementing the builtin documentation generator.</td> |
| 31 </tr> | 30 </tr> |
| 32 <tr> | 31 <tr> |
| 33 <td><a href="#TagError">TagError</a></td> | 32 <td><a href="#TagError">TagError</a></td> |
| 34 <td>Exception class raised, if an invalid documentation tag was found.</td> | 33 <td>Exception class raised, if an invalid documentation tag was found.</td> |
| 35 </tr> | 34 </tr> |
| 36 </table> | 35 </table> |
| 36 | |
| 37 <h3>Functions</h3> | 37 <h3>Functions</h3> |
| 38 | |
| 39 <table> | 38 <table> |
| 40 <tr><td>None</td></tr> | 39 <tr><td>None</td></tr> |
| 41 </table> | 40 </table> |
| 41 | |
| 42 <hr /> | 42 <hr /> |
| 43 <hr /> | 43 <hr /> |
| 44 <a NAME="ModuleDocument" ID="ModuleDocument"></a> | 44 <a NAME="ModuleDocument" ID="ModuleDocument"></a> |
| 45 <h2>ModuleDocument</h2> | 45 <h2>ModuleDocument</h2> |
| 46 | |
| 47 <p> | 46 <p> |
| 48 Class implementing the builtin documentation generator. | 47 Class implementing the builtin documentation generator. |
| 49 </p> | 48 </p> |
| 49 | |
| 50 <h3>Derived from</h3> | 50 <h3>Derived from</h3> |
| 51 None | 51 None |
| 52 <h3>Class Attributes</h3> | 52 <h3>Class Attributes</h3> |
| 53 | |
| 54 <table> | 53 <table> |
| 55 <tr><td>None</td></tr> | 54 <tr><td>None</td></tr> |
| 56 </table> | 55 </table> |
| 56 | |
| 57 <h3>Class Methods</h3> | 57 <h3>Class Methods</h3> |
| 58 | |
| 59 <table> | 58 <table> |
| 60 <tr><td>None</td></tr> | 59 <tr><td>None</td></tr> |
| 61 </table> | 60 </table> |
| 61 | |
| 62 <h3>Methods</h3> | 62 <h3>Methods</h3> |
| 63 | 63 <table> |
| 64 <table> | |
| 65 | |
| 66 <tr> | 64 <tr> |
| 67 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td> | 65 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td> |
| 68 <td>Constructor</td> | 66 <td>Constructor</td> |
| 69 </tr> | 67 </tr> |
| 70 <tr> | 68 <tr> |
| 178 <tr> | 176 <tr> |
| 179 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td> | 177 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td> |
| 180 <td>Public method used to get the short description of the module.</td> | 178 <td>Public method used to get the short description of the module.</td> |
| 181 </tr> | 179 </tr> |
| 182 </table> | 180 </table> |
| 181 | |
| 183 <h3>Static Methods</h3> | 182 <h3>Static Methods</h3> |
| 184 | |
| 185 <table> | 183 <table> |
| 186 <tr><td>None</td></tr> | 184 <tr><td>None</td></tr> |
| 187 </table> | 185 </table> |
| 186 | |
| 188 | 187 |
| 189 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> | 188 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> |
| 190 <h4>ModuleDocument (Constructor)</h4> | 189 <h4>ModuleDocument (Constructor)</h4> |
| 191 <b>ModuleDocument</b>(<i>module</i>) | 190 <b>ModuleDocument</b>(<i>module</i>) |
| 192 | |
| 193 <p> | 191 <p> |
| 194 Constructor | 192 Constructor |
| 195 </p> | 193 </p> |
| 194 | |
| 196 <dl> | 195 <dl> |
| 197 | 196 |
| 198 <dt><i>module</i> (str)</dt> | 197 <dt><i>module</i> (str)</dt> |
| 199 <dd> | 198 <dd> |
| 200 information of the parsed Python file | 199 information of the parsed Python file |
| 201 </dd> | 200 </dd> |
| 202 </dl> | 201 </dl> |
| 203 <a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a> | 202 <a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a> |
| 204 <h4>ModuleDocument.__checkDeprecated</h4> | 203 <h4>ModuleDocument.__checkDeprecated</h4> |
| 205 <b>__checkDeprecated</b>(<i>descr</i>) | 204 <b>__checkDeprecated</b>(<i>descr</i>) |
| 206 | |
| 207 <p> | 205 <p> |
| 208 Private method to check, if the object to be documented contains a | 206 Private method to check, if the object to be documented contains a |
| 209 deprecated flag. | 207 deprecated flag. |
| 210 </p> | 208 </p> |
| 209 | |
| 211 <dl> | 210 <dl> |
| 212 | 211 |
| 213 <dt><i>descr</i> (str)</dt> | 212 <dt><i>descr</i> (str)</dt> |
| 214 <dd> | 213 <dd> |
| 215 documentation string | 214 documentation string |
| 228 </dd> | 227 </dd> |
| 229 </dl> | 228 </dl> |
| 230 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> | 229 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> |
| 231 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> | 230 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> |
| 232 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) | 231 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) |
| 233 | |
| 234 <p> | 232 <p> |
| 235 Private method to format a cross reference entry. | 233 Private method to format a cross reference entry. |
| 236 </p> | 234 </p> |
| 237 <p> | 235 <p> |
| 238 This cross reference entry looks like "package.module#member label". | 236 This cross reference entry looks like "package.module#member label". |
| 239 </p> | 237 </p> |
| 238 | |
| 240 <dl> | 239 <dl> |
| 241 | 240 |
| 242 <dt><i>entry</i> (str)</dt> | 241 <dt><i>entry</i> (str)</dt> |
| 243 <dd> | 242 <dd> |
| 244 entry to be formatted | 243 entry to be formatted |
| 257 </dd> | 256 </dd> |
| 258 </dl> | 257 </dl> |
| 259 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> | 258 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> |
| 260 <h4>ModuleDocument.__formatDescription</h4> | 259 <h4>ModuleDocument.__formatDescription</h4> |
| 261 <b>__formatDescription</b>(<i>descr</i>) | 260 <b>__formatDescription</b>(<i>descr</i>) |
| 262 | |
| 263 <p> | 261 <p> |
| 264 Private method to format the contents of the documentation string. | 262 Private method to format the contents of the documentation string. |
| 265 </p> | 263 </p> |
| 264 | |
| 266 <dl> | 265 <dl> |
| 267 | 266 |
| 268 <dt><i>descr</i> (str)</dt> | 267 <dt><i>descr</i> (str)</dt> |
| 269 <dd> | 268 <dd> |
| 270 contents of the documentation string | 269 contents of the documentation string |
| 290 </dd> | 289 </dd> |
| 291 </dl> | 290 </dl> |
| 292 <a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> | 291 <a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> |
| 293 <h4>ModuleDocument.__genClassListSection</h4> | 292 <h4>ModuleDocument.__genClassListSection</h4> |
| 294 <b>__genClassListSection</b>(<i></i>) | 293 <b>__genClassListSection</b>(<i></i>) |
| 295 | |
| 296 <p> | 294 <p> |
| 297 Private method to generate the section listing all classes of the | 295 Private method to generate the section listing all classes of the |
| 298 module. | 296 module. |
| 299 </p> | 297 </p> |
| 298 | |
| 300 <dl> | 299 <dl> |
| 301 <dt>Return:</dt> | 300 <dt>Return:</dt> |
| 302 <dd> | 301 <dd> |
| 303 classes list section | 302 classes list section |
| 304 </dd> | 303 </dd> |
| 310 </dd> | 309 </dd> |
| 311 </dl> | 310 </dl> |
| 312 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> | 311 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> |
| 313 <h4>ModuleDocument.__genClassesSection</h4> | 312 <h4>ModuleDocument.__genClassesSection</h4> |
| 314 <b>__genClassesSection</b>(<i></i>) | 313 <b>__genClassesSection</b>(<i></i>) |
| 315 | |
| 316 <p> | 314 <p> |
| 317 Private method to generate the document section with details about | 315 Private method to generate the document section with details about |
| 318 classes. | 316 classes. |
| 319 </p> | 317 </p> |
| 318 | |
| 320 <dl> | 319 <dl> |
| 321 <dt>Return:</dt> | 320 <dt>Return:</dt> |
| 322 <dd> | 321 <dd> |
| 323 classes details section | 322 classes details section |
| 324 </dd> | 323 </dd> |
| 330 </dd> | 329 </dd> |
| 331 </dl> | 330 </dl> |
| 332 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> | 331 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> |
| 333 <h4>ModuleDocument.__genDescriptionListSection</h4> | 332 <h4>ModuleDocument.__genDescriptionListSection</h4> |
| 334 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>) | 333 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>) |
| 335 | |
| 336 <p> | 334 <p> |
| 337 Private method to generate the list section of a description. | 335 Private method to generate the list section of a description. |
| 338 </p> | 336 </p> |
| 337 | |
| 339 <dl> | 338 <dl> |
| 340 | 339 |
| 341 <dt><i>dictionary</i> (dict)</dt> | 340 <dt><i>dictionary</i> (dict)</dt> |
| 342 <dd> | 341 <dd> |
| 343 dictionary containing the info for the | 342 dictionary containing the info for the |
| 361 </dd> | 360 </dd> |
| 362 </dl> | 361 </dl> |
| 363 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> | 362 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> |
| 364 <h4>ModuleDocument.__genFunctionListSection</h4> | 363 <h4>ModuleDocument.__genFunctionListSection</h4> |
| 365 <b>__genFunctionListSection</b>(<i></i>) | 364 <b>__genFunctionListSection</b>(<i></i>) |
| 366 | |
| 367 <p> | 365 <p> |
| 368 Private method to generate the section listing all functions of the | 366 Private method to generate the section listing all functions of the |
| 369 module. | 367 module. |
| 370 </p> | 368 </p> |
| 369 | |
| 371 <dl> | 370 <dl> |
| 372 <dt>Return:</dt> | 371 <dt>Return:</dt> |
| 373 <dd> | 372 <dd> |
| 374 functions list section | 373 functions list section |
| 375 </dd> | 374 </dd> |
| 381 </dd> | 380 </dd> |
| 382 </dl> | 381 </dl> |
| 383 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> | 382 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> |
| 384 <h4>ModuleDocument.__genFunctionsSection</h4> | 383 <h4>ModuleDocument.__genFunctionsSection</h4> |
| 385 <b>__genFunctionsSection</b>(<i></i>) | 384 <b>__genFunctionsSection</b>(<i></i>) |
| 386 | |
| 387 <p> | 385 <p> |
| 388 Private method to generate the document section with details about | 386 Private method to generate the document section with details about |
| 389 functions. | 387 functions. |
| 390 </p> | 388 </p> |
| 389 | |
| 391 <dl> | 390 <dl> |
| 392 <dt>Return:</dt> | 391 <dt>Return:</dt> |
| 393 <dd> | 392 <dd> |
| 394 functions details section | 393 functions details section |
| 395 </dd> | 394 </dd> |
| 401 </dd> | 400 </dd> |
| 402 </dl> | 401 </dl> |
| 403 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> | 402 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> |
| 404 <h4>ModuleDocument.__genGlobalsListSection</h4> | 403 <h4>ModuleDocument.__genGlobalsListSection</h4> |
| 405 <b>__genGlobalsListSection</b>(<i>class_=None</i>) | 404 <b>__genGlobalsListSection</b>(<i>class_=None</i>) |
| 406 | |
| 407 <p> | 405 <p> |
| 408 Private method to generate the section listing all global attributes of | 406 Private method to generate the section listing all global attributes of |
| 409 the module. | 407 the module. |
| 410 </p> | 408 </p> |
| 409 | |
| 411 <dl> | 410 <dl> |
| 412 | 411 |
| 413 <dt><i>class_</i> (class)</dt> | 412 <dt><i>class_</i> (class)</dt> |
| 414 <dd> | 413 <dd> |
| 415 reference to a class object | 414 reference to a class object |
| 428 </dd> | 427 </dd> |
| 429 </dl> | 428 </dl> |
| 430 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> | 429 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> |
| 431 <h4>ModuleDocument.__genListSection</h4> | 430 <h4>ModuleDocument.__genListSection</h4> |
| 432 <b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>) | 431 <b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>) |
| 433 | |
| 434 <p> | 432 <p> |
| 435 Private method to generate a list section of the document. | 433 Private method to generate a list section of the document. |
| 436 </p> | 434 </p> |
| 435 | |
| 437 <dl> | 436 <dl> |
| 438 | 437 |
| 439 <dt><i>names</i> (list of str)</dt> | 438 <dt><i>names</i> (list of str)</dt> |
| 440 <dd> | 439 <dd> |
| 441 names to appear in the list | 440 names to appear in the list |
| 462 </dd> | 461 </dd> |
| 463 </dl> | 462 </dl> |
| 464 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> | 463 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> |
| 465 <h4>ModuleDocument.__genMethodSection</h4> | 464 <h4>ModuleDocument.__genMethodSection</h4> |
| 466 <b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>) | 465 <b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>) |
| 467 | |
| 468 <p> | 466 <p> |
| 469 Private method to generate the method details section. | 467 Private method to generate the method details section. |
| 470 </p> | 468 </p> |
| 469 | |
| 471 <dl> | 470 <dl> |
| 472 | 471 |
| 473 <dt><i>obj</i> (class)</dt> | 472 <dt><i>obj</i> (class)</dt> |
| 474 <dd> | 473 <dd> |
| 475 reference to the object being formatted | 474 reference to the object being formatted |
| 496 </dd> | 495 </dd> |
| 497 </dl> | 496 </dl> |
| 498 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> | 497 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> |
| 499 <h4>ModuleDocument.__genMethodsListSection</h4> | 498 <h4>ModuleDocument.__genMethodsListSection</h4> |
| 500 <b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>) | 499 <b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>) |
| 501 | |
| 502 <p> | 500 <p> |
| 503 Private method to generate the methods list section of a class. | 501 Private method to generate the methods list section of a class. |
| 504 </p> | 502 </p> |
| 503 | |
| 505 <dl> | 504 <dl> |
| 506 | 505 |
| 507 <dt><i>names</i> (list of str)</dt> | 506 <dt><i>names</i> (list of str)</dt> |
| 508 <dd> | 507 <dd> |
| 509 names to appear in the list | 508 names to appear in the list |
| 538 </dd> | 537 </dd> |
| 539 </dl> | 538 </dl> |
| 540 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> | 539 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> |
| 541 <h4>ModuleDocument.__genModuleSection</h4> | 540 <h4>ModuleDocument.__genModuleSection</h4> |
| 542 <b>__genModuleSection</b>(<i></i>) | 541 <b>__genModuleSection</b>(<i></i>) |
| 543 | |
| 544 <p> | 542 <p> |
| 545 Private method to generate the body of the document. | 543 Private method to generate the body of the document. |
| 546 </p> | 544 </p> |
| 545 | |
| 547 <dl> | 546 <dl> |
| 548 <dt>Return:</dt> | 547 <dt>Return:</dt> |
| 549 <dd> | 548 <dd> |
| 550 body of the document | 549 body of the document |
| 551 </dd> | 550 </dd> |
| 557 </dd> | 556 </dd> |
| 558 </dl> | 557 </dl> |
| 559 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> | 558 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> |
| 560 <h4>ModuleDocument.__genParagraphs</h4> | 559 <h4>ModuleDocument.__genParagraphs</h4> |
| 561 <b>__genParagraphs</b>(<i>lines</i>) | 560 <b>__genParagraphs</b>(<i>lines</i>) |
| 562 | |
| 563 <p> | 561 <p> |
| 564 Private method to assemble the descriptive paragraphs of a docstring. | 562 Private method to assemble the descriptive paragraphs of a docstring. |
| 565 </p> | 563 </p> |
| 566 <p> | 564 <p> |
| 567 A paragraph is made up of a number of consecutive lines without | 565 A paragraph is made up of a number of consecutive lines without |
| 568 an intermediate empty line. Empty lines are treated as a paragraph | 566 an intermediate empty line. Empty lines are treated as a paragraph |
| 569 delimiter. | 567 delimiter. |
| 570 </p> | 568 </p> |
| 569 | |
| 571 <dl> | 570 <dl> |
| 572 | 571 |
| 573 <dt><i>lines</i> (list of str)</dt> | 572 <dt><i>lines</i> (list of str)</dt> |
| 574 <dd> | 573 <dd> |
| 575 list of individual lines | 574 list of individual lines |
| 588 </dd> | 587 </dd> |
| 589 </dl> | 588 </dl> |
| 590 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> | 589 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> |
| 591 <h4>ModuleDocument.__genParamDescriptionListSection</h4> | 590 <h4>ModuleDocument.__genParamDescriptionListSection</h4> |
| 592 <b>__genParamDescriptionListSection</b>(<i>_list</i>) | 591 <b>__genParamDescriptionListSection</b>(<i>_list</i>) |
| 593 | |
| 594 <p> | 592 <p> |
| 595 Private method to generate the list section of a description. | 593 Private method to generate the list section of a description. |
| 596 </p> | 594 </p> |
| 595 | |
| 597 <dl> | 596 <dl> |
| 598 | 597 |
| 599 <dt><i>_list</i> (list of lists with three elements)</dt> | 598 <dt><i>_list</i> (list of lists with three elements)</dt> |
| 600 <dd> | 599 <dd> |
| 601 list containing the info for the parameter description | 600 list containing the info for the parameter description |
| 615 </dd> | 614 </dd> |
| 616 </dl> | 615 </dl> |
| 617 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> | 616 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> |
| 618 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> | 617 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> |
| 619 <b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>) | 618 <b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>) |
| 620 | |
| 621 <p> | 619 <p> |
| 622 Private method to generate the classes list section of a Ruby module. | 620 Private method to generate the classes list section of a Ruby module. |
| 623 </p> | 621 </p> |
| 622 | |
| 624 <dl> | 623 <dl> |
| 625 | 624 |
| 626 <dt><i>names</i> (list of str)</dt> | 625 <dt><i>names</i> (list of str)</dt> |
| 627 <dd> | 626 <dd> |
| 628 names to appear in the list | 627 names to appear in the list |
| 649 </dd> | 648 </dd> |
| 650 </dl> | 649 </dl> |
| 651 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> | 650 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> |
| 652 <h4>ModuleDocument.__genRbModulesClassesSection</h4> | 651 <h4>ModuleDocument.__genRbModulesClassesSection</h4> |
| 653 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>) | 652 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>) |
| 654 | |
| 655 <p> | 653 <p> |
| 656 Private method to generate the Ruby module classes details section. | 654 Private method to generate the Ruby module classes details section. |
| 657 </p> | 655 </p> |
| 656 | |
| 658 <dl> | 657 <dl> |
| 659 | 658 |
| 660 <dt><i>obj</i> (class)</dt> | 659 <dt><i>obj</i> (class)</dt> |
| 661 <dd> | 660 <dd> |
| 662 reference to the object being formatted | 661 reference to the object being formatted |
| 679 </dd> | 678 </dd> |
| 680 </dl> | 679 </dl> |
| 681 <a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> | 680 <a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> |
| 682 <h4>ModuleDocument.__genRbModulesListSection</h4> | 681 <h4>ModuleDocument.__genRbModulesListSection</h4> |
| 683 <b>__genRbModulesListSection</b>(<i></i>) | 682 <b>__genRbModulesListSection</b>(<i></i>) |
| 684 | |
| 685 <p> | 683 <p> |
| 686 Private method to generate the section listing all modules of the file | 684 Private method to generate the section listing all modules of the file |
| 687 (Ruby only). | 685 (Ruby only). |
| 688 </p> | 686 </p> |
| 687 | |
| 689 <dl> | 688 <dl> |
| 690 <dt>Return:</dt> | 689 <dt>Return:</dt> |
| 691 <dd> | 690 <dd> |
| 692 modules list section | 691 modules list section |
| 693 </dd> | 692 </dd> |
| 699 </dd> | 698 </dd> |
| 700 </dl> | 699 </dl> |
| 701 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> | 700 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> |
| 702 <h4>ModuleDocument.__genRbModulesSection</h4> | 701 <h4>ModuleDocument.__genRbModulesSection</h4> |
| 703 <b>__genRbModulesSection</b>(<i></i>) | 702 <b>__genRbModulesSection</b>(<i></i>) |
| 704 | |
| 705 <p> | 703 <p> |
| 706 Private method to generate the document section with details about | 704 Private method to generate the document section with details about |
| 707 Ruby modules. | 705 Ruby modules. |
| 708 </p> | 706 </p> |
| 707 | |
| 709 <dl> | 708 <dl> |
| 710 <dt>Return:</dt> | 709 <dt>Return:</dt> |
| 711 <dd> | 710 <dd> |
| 712 Ruby modules details section | 711 Ruby modules details section |
| 713 </dd> | 712 </dd> |
| 719 </dd> | 718 </dd> |
| 720 </dl> | 719 </dl> |
| 721 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> | 720 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> |
| 722 <h4>ModuleDocument.__genSeeListSection</h4> | 721 <h4>ModuleDocument.__genSeeListSection</h4> |
| 723 <b>__genSeeListSection</b>(<i>_list, template</i>) | 722 <b>__genSeeListSection</b>(<i>_list, template</i>) |
| 724 | |
| 725 <p> | 723 <p> |
| 726 Private method to generate the "see also" list section of a | 724 Private method to generate the "see also" list section of a |
| 727 description. | 725 description. |
| 728 </p> | 726 </p> |
| 727 | |
| 729 <dl> | 728 <dl> |
| 730 | 729 |
| 731 <dt><i>_list</i> (list)</dt> | 730 <dt><i>_list</i> (list)</dt> |
| 732 <dd> | 731 <dd> |
| 733 list containing the info for the section | 732 list containing the info for the section |
| 750 </dd> | 749 </dd> |
| 751 </dl> | 750 </dl> |
| 752 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> | 751 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> |
| 753 <h4>ModuleDocument.__getShortDescription</h4> | 752 <h4>ModuleDocument.__getShortDescription</h4> |
| 754 <b>__getShortDescription</b>(<i>desc</i>) | 753 <b>__getShortDescription</b>(<i>desc</i>) |
| 755 | |
| 756 <p> | 754 <p> |
| 757 Private method to determine the short description of an object. | 755 Private method to determine the short description of an object. |
| 758 </p> | 756 </p> |
| 759 <p> | 757 <p> |
| 760 The short description is just the first non empty line of the | 758 The short description is just the first non empty line of the |
| 761 documentation string. | 759 documentation string. |
| 762 </p> | 760 </p> |
| 761 | |
| 763 <dl> | 762 <dl> |
| 764 | 763 |
| 765 <dt><i>desc</i> (str)</dt> | 764 <dt><i>desc</i> (str)</dt> |
| 766 <dd> | 765 <dd> |
| 767 documentation string | 766 documentation string |
| 780 </dd> | 779 </dd> |
| 781 </dl> | 780 </dl> |
| 782 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> | 781 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> |
| 783 <h4>ModuleDocument.__processInlineTags</h4> | 782 <h4>ModuleDocument.__processInlineTags</h4> |
| 784 <b>__processInlineTags</b>(<i>desc</i>) | 783 <b>__processInlineTags</b>(<i>desc</i>) |
| 785 | |
| 786 <p> | 784 <p> |
| 787 Private method to process inline tags. | 785 Private method to process inline tags. |
| 788 </p> | 786 </p> |
| 787 | |
| 789 <dl> | 788 <dl> |
| 790 | 789 |
| 791 <dt><i>desc</i> (str)</dt> | 790 <dt><i>desc</i> (str)</dt> |
| 792 <dd> | 791 <dd> |
| 793 one line of the description | 792 one line of the description |
| 813 </dd> | 812 </dd> |
| 814 </dl> | 813 </dl> |
| 815 <a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a> | 814 <a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a> |
| 816 <h4>ModuleDocument.description</h4> | 815 <h4>ModuleDocument.description</h4> |
| 817 <b>description</b>(<i></i>) | 816 <b>description</b>(<i></i>) |
| 818 | |
| 819 <p> | 817 <p> |
| 820 Public method used to get the description of the module. | 818 Public method used to get the description of the module. |
| 821 </p> | 819 </p> |
| 820 | |
| 822 <dl> | 821 <dl> |
| 823 <dt>Return:</dt> | 822 <dt>Return:</dt> |
| 824 <dd> | 823 <dd> |
| 825 description of the module | 824 description of the module |
| 826 </dd> | 825 </dd> |
| 832 </dd> | 831 </dd> |
| 833 </dl> | 832 </dl> |
| 834 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> | 833 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> |
| 835 <h4>ModuleDocument.genDocument</h4> | 834 <h4>ModuleDocument.genDocument</h4> |
| 836 <b>genDocument</b>(<i></i>) | 835 <b>genDocument</b>(<i></i>) |
| 837 | |
| 838 <p> | 836 <p> |
| 839 Public method to generate the source code documentation. | 837 Public method to generate the source code documentation. |
| 840 </p> | 838 </p> |
| 839 | |
| 841 <dl> | 840 <dl> |
| 842 <dt>Return:</dt> | 841 <dt>Return:</dt> |
| 843 <dd> | 842 <dd> |
| 844 source code documentation | 843 source code documentation |
| 845 </dd> | 844 </dd> |
| 851 </dd> | 850 </dd> |
| 852 </dl> | 851 </dl> |
| 853 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> | 852 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> |
| 854 <h4>ModuleDocument.getQtHelpKeywords</h4> | 853 <h4>ModuleDocument.getQtHelpKeywords</h4> |
| 855 <b>getQtHelpKeywords</b>(<i></i>) | 854 <b>getQtHelpKeywords</b>(<i></i>) |
| 856 | |
| 857 <p> | 855 <p> |
| 858 Public method to retrieve the parts for the QtHelp keywords section. | 856 Public method to retrieve the parts for the QtHelp keywords section. |
| 859 </p> | 857 </p> |
| 858 | |
| 860 <dl> | 859 <dl> |
| 861 <dt>Return:</dt> | 860 <dt>Return:</dt> |
| 862 <dd> | 861 <dd> |
| 863 list of tuples containing the name and the ref. The ref is without | 862 list of tuples containing the name and the ref. The ref is without |
| 864 the filename part. | 863 the filename part. |
| 871 </dd> | 870 </dd> |
| 872 </dl> | 871 </dl> |
| 873 <a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> | 872 <a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> |
| 874 <h4>ModuleDocument.isEmpty</h4> | 873 <h4>ModuleDocument.isEmpty</h4> |
| 875 <b>isEmpty</b>(<i></i>) | 874 <b>isEmpty</b>(<i></i>) |
| 876 | |
| 877 <p> | 875 <p> |
| 878 Public method to determine, if the module contains any classes or | 876 Public method to determine, if the module contains any classes or |
| 879 functions. | 877 functions. |
| 880 </p> | 878 </p> |
| 879 | |
| 881 <dl> | 880 <dl> |
| 882 <dt>Return:</dt> | 881 <dt>Return:</dt> |
| 883 <dd> | 882 <dd> |
| 884 flag indicating an empty module (i.e. __init__.py without | 883 flag indicating an empty module (i.e. __init__.py without |
| 885 any contents) | 884 any contents) |
| 892 </dd> | 891 </dd> |
| 893 </dl> | 892 </dl> |
| 894 <a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a> | 893 <a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a> |
| 895 <h4>ModuleDocument.name</h4> | 894 <h4>ModuleDocument.name</h4> |
| 896 <b>name</b>(<i></i>) | 895 <b>name</b>(<i></i>) |
| 897 | |
| 898 <p> | 896 <p> |
| 899 Public method used to get the module name. | 897 Public method used to get the module name. |
| 900 </p> | 898 </p> |
| 899 | |
| 901 <dl> | 900 <dl> |
| 902 <dt>Return:</dt> | 901 <dt>Return:</dt> |
| 903 <dd> | 902 <dd> |
| 904 name of the module | 903 name of the module |
| 905 </dd> | 904 </dd> |
| 911 </dd> | 910 </dd> |
| 912 </dl> | 911 </dl> |
| 913 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> | 912 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> |
| 914 <h4>ModuleDocument.shortDescription</h4> | 913 <h4>ModuleDocument.shortDescription</h4> |
| 915 <b>shortDescription</b>(<i></i>) | 914 <b>shortDescription</b>(<i></i>) |
| 916 | |
| 917 <p> | 915 <p> |
| 918 Public method used to get the short description of the module. | 916 Public method used to get the short description of the module. |
| 919 </p> | 917 </p> |
| 920 <p> | 918 <p> |
| 921 The short description is just the first line of the modules | 919 The short description is just the first line of the modules |
| 922 description. | 920 description. |
| 923 </p> | 921 </p> |
| 922 | |
| 924 <dl> | 923 <dl> |
| 925 <dt>Return:</dt> | 924 <dt>Return:</dt> |
| 926 <dd> | 925 <dd> |
| 927 short description of the module | 926 short description of the module |
| 928 </dd> | 927 </dd> |
| 936 <div align="right"><a href="#top">Up</a></div> | 935 <div align="right"><a href="#top">Up</a></div> |
| 937 <hr /> | 936 <hr /> |
| 938 <hr /> | 937 <hr /> |
| 939 <a NAME="TagError" ID="TagError"></a> | 938 <a NAME="TagError" ID="TagError"></a> |
| 940 <h2>TagError</h2> | 939 <h2>TagError</h2> |
| 941 | |
| 942 <p> | 940 <p> |
| 943 Exception class raised, if an invalid documentation tag was found. | 941 Exception class raised, if an invalid documentation tag was found. |
| 944 </p> | 942 </p> |
| 943 | |
| 945 <h3>Derived from</h3> | 944 <h3>Derived from</h3> |
| 946 Exception | 945 Exception |
| 947 <h3>Class Attributes</h3> | 946 <h3>Class Attributes</h3> |
| 948 | |
| 949 <table> | 947 <table> |
| 950 <tr><td>None</td></tr> | 948 <tr><td>None</td></tr> |
| 951 </table> | 949 </table> |
| 950 | |
| 952 <h3>Class Methods</h3> | 951 <h3>Class Methods</h3> |
| 953 | |
| 954 <table> | 952 <table> |
| 955 <tr><td>None</td></tr> | 953 <tr><td>None</td></tr> |
| 956 </table> | 954 </table> |
| 955 | |
| 957 <h3>Methods</h3> | 956 <h3>Methods</h3> |
| 958 | |
| 959 <table> | 957 <table> |
| 960 <tr><td>None</td></tr> | 958 <tr><td>None</td></tr> |
| 961 </table> | 959 </table> |
| 960 | |
| 962 <h3>Static Methods</h3> | 961 <h3>Static Methods</h3> |
| 963 | |
| 964 <table> | 962 <table> |
| 965 <tr><td>None</td></tr> | 963 <tr><td>None</td></tr> |
| 966 </table> | 964 </table> |
| 965 | |
| 967 | 966 |
| 968 <div align="right"><a href="#top">Up</a></div> | 967 <div align="right"><a href="#top">Up</a></div> |
| 969 <hr /> | 968 <hr /> |
| 970 </body></html> | 969 </body></html> |
