Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
- changeset 3018
- 70924c0bdaf1
- parent 2966
- f85f686981ad
equal
deleted
inserted
replaced
| 3017:6a8cb7632448 | 3018:70924c0bdaf1 |
|---|---|
| 229 </dd> | 229 </dd> |
| 230 </dl><a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> | 230 </dl><a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> |
| 231 <h4>ModuleDocument.__genClassListSection</h4> | 231 <h4>ModuleDocument.__genClassListSection</h4> |
| 232 <b>__genClassListSection</b>(<i></i>) | 232 <b>__genClassListSection</b>(<i></i>) |
| 233 <p> | 233 <p> |
| 234 Private method to generate the section listing all classes of the module. | 234 Private method to generate the section listing all classes of the |
| 235 module. | |
| 235 </p><dl> | 236 </p><dl> |
| 236 <dt>Returns:</dt> | 237 <dt>Returns:</dt> |
| 237 <dd> | 238 <dd> |
| 238 The classes list section. (string) | 239 The classes list section. (string) |
| 239 </dd> | 240 </dd> |
| 240 </dl><a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> | 241 </dl><a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> |
| 241 <h4>ModuleDocument.__genClassesSection</h4> | 242 <h4>ModuleDocument.__genClassesSection</h4> |
| 242 <b>__genClassesSection</b>(<i></i>) | 243 <b>__genClassesSection</b>(<i></i>) |
| 243 <p> | 244 <p> |
| 244 Private method to generate the document section with details about classes. | 245 Private method to generate the document section with details about |
| 246 classes. | |
| 245 </p><dl> | 247 </p><dl> |
| 246 <dt>Returns:</dt> | 248 <dt>Returns:</dt> |
| 247 <dd> | 249 <dd> |
| 248 The classes details section. (string) | 250 The classes details section. (string) |
| 249 </dd> | 251 </dd> |
| 268 </dd> | 270 </dd> |
| 269 </dl><a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> | 271 </dl><a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> |
| 270 <h4>ModuleDocument.__genFunctionListSection</h4> | 272 <h4>ModuleDocument.__genFunctionListSection</h4> |
| 271 <b>__genFunctionListSection</b>(<i></i>) | 273 <b>__genFunctionListSection</b>(<i></i>) |
| 272 <p> | 274 <p> |
| 273 Private method to generate the section listing all functions of the module. | 275 Private method to generate the section listing all functions of the |
| 276 module. | |
| 274 </p><dl> | 277 </p><dl> |
| 275 <dt>Returns:</dt> | 278 <dt>Returns:</dt> |
| 276 <dd> | 279 <dd> |
| 277 The functions list section. (string) | 280 The functions list section. (string) |
| 278 </dd> | 281 </dd> |
| 279 </dl><a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> | 282 </dl><a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> |
| 280 <h4>ModuleDocument.__genFunctionsSection</h4> | 283 <h4>ModuleDocument.__genFunctionsSection</h4> |
| 281 <b>__genFunctionsSection</b>(<i></i>) | 284 <b>__genFunctionsSection</b>(<i></i>) |
| 282 <p> | 285 <p> |
| 283 Private method to generate the document section with details about functions. | 286 Private method to generate the document section with details about |
| 287 functions. | |
| 284 </p><dl> | 288 </p><dl> |
| 285 <dt>Returns:</dt> | 289 <dt>Returns:</dt> |
| 286 <dd> | 290 <dd> |
| 287 The functions details section. (string) | 291 The functions details section. (string) |
| 288 </dd> | 292 </dd> |
| 362 </dd><dt><i>clsName</i></dt> | 366 </dd><dt><i>clsName</i></dt> |
| 363 <dd> | 367 <dd> |
| 364 visible class name containing the names | 368 visible class name containing the names |
| 365 </dd><dt><i>includeInit</i></dt> | 369 </dd><dt><i>includeInit</i></dt> |
| 366 <dd> | 370 <dd> |
| 367 flag indicating to include the __init__ method (boolean) | 371 flag indicating to include the __init__ method |
| 372 (boolean) | |
| 368 </dd> | 373 </dd> |
| 369 </dl><dl> | 374 </dl><dl> |
| 370 <dt>Returns:</dt> | 375 <dt>Returns:</dt> |
| 371 <dd> | 376 <dd> |
| 372 methods list section (string) | 377 methods list section (string) |
| 431 </dd><dt><i>dict</i></dt> | 436 </dd><dt><i>dict</i></dt> |
| 432 <dd> | 437 <dd> |
| 433 A dictionary containing all relevant information. | 438 A dictionary containing all relevant information. |
| 434 </dd><dt><i>moduleName</i></dt> | 439 </dd><dt><i>moduleName</i></dt> |
| 435 <dd> | 440 <dd> |
| 436 Name of the Ruby module containing the classes. (string) | 441 Name of the Ruby module containing the classes. |
| 442 (string) | |
| 437 </dd> | 443 </dd> |
| 438 </dl><dl> | 444 </dl><dl> |
| 439 <dt>Returns:</dt> | 445 <dt>Returns:</dt> |
| 440 <dd> | 446 <dd> |
| 441 The list section. (string) | 447 The list section. (string) |
| 454 Name of the Ruby module containing the classes. (string) | 460 Name of the Ruby module containing the classes. (string) |
| 455 </dd> | 461 </dd> |
| 456 </dl><dl> | 462 </dl><dl> |
| 457 <dt>Returns:</dt> | 463 <dt>Returns:</dt> |
| 458 <dd> | 464 <dd> |
| 459 The classes list and classes details section. (tuple of two string) | 465 The classes list and classes details section. |
| 466 (tuple of two string) | |
| 460 </dd> | 467 </dd> |
| 461 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> | 468 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> |
| 462 <h4>ModuleDocument.__genRbModulesListSection</h4> | 469 <h4>ModuleDocument.__genRbModulesListSection</h4> |
| 463 <b>__genRbModulesListSection</b>(<i></i>) | 470 <b>__genRbModulesListSection</b>(<i></i>) |
| 464 <p> | 471 <p> |
| 471 </dd> | 478 </dd> |
| 472 </dl><a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> | 479 </dl><a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> |
| 473 <h4>ModuleDocument.__genRbModulesSection</h4> | 480 <h4>ModuleDocument.__genRbModulesSection</h4> |
| 474 <b>__genRbModulesSection</b>(<i></i>) | 481 <b>__genRbModulesSection</b>(<i></i>) |
| 475 <p> | 482 <p> |
| 476 Private method to generate the document section with details about Ruby modules. | 483 Private method to generate the document section with details about |
| 484 Ruby modules. | |
| 477 </p><dl> | 485 </p><dl> |
| 478 <dt>Returns:</dt> | 486 <dt>Returns:</dt> |
| 479 <dd> | 487 <dd> |
| 480 The Ruby modules details section. (string) | 488 The Ruby modules details section. (string) |
| 481 </dd> | 489 </dd> |
| 482 </dl><a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> | 490 </dl><a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> |
| 483 <h4>ModuleDocument.__genSeeListSection</h4> | 491 <h4>ModuleDocument.__genSeeListSection</h4> |
| 484 <b>__genSeeListSection</b>(<i>_list, template</i>) | 492 <b>__genSeeListSection</b>(<i>_list, template</i>) |
| 485 <p> | 493 <p> |
| 486 Private method to generate the "see also" list section of a description. | 494 Private method to generate the "see also" list section of a |
| 495 description. | |
| 487 </p><dl> | 496 </p><dl> |
| 488 <dt><i>_list</i></dt> | 497 <dt><i>_list</i></dt> |
| 489 <dd> | 498 <dd> |
| 490 List containing the info for the section. | 499 List containing the info for the section. |
| 491 </dd><dt><i>template</i></dt> | 500 </dd><dt><i>template</i></dt> |
| 561 <p> | 570 <p> |
| 562 Public method to retrieve the parts for the QtHelp keywords section. | 571 Public method to retrieve the parts for the QtHelp keywords section. |
| 563 </p><dl> | 572 </p><dl> |
| 564 <dt>Returns:</dt> | 573 <dt>Returns:</dt> |
| 565 <dd> | 574 <dd> |
| 566 list of tuples containing the name (string) and the ref (string). The ref | 575 list of tuples containing the name (string) and the ref |
| 567 is without the filename part. | 576 (string). The ref is without the filename part. |
| 568 </dd> | 577 </dd> |
| 569 </dl><a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> | 578 </dl><a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> |
| 570 <h4>ModuleDocument.isEmpty</h4> | 579 <h4>ModuleDocument.isEmpty</h4> |
| 571 <b>isEmpty</b>(<i></i>) | 580 <b>isEmpty</b>(<i></i>) |
| 572 <p> | 581 <p> |
| 573 Public method to determine, if the module contains any classes or functions. | 582 Public method to determine, if the module contains any classes or |
| 583 functions. | |
| 574 </p><dl> | 584 </p><dl> |
| 575 <dt>Returns:</dt> | 585 <dt>Returns:</dt> |
| 576 <dd> | 586 <dd> |
| 577 Flag indicating an empty module (i.e. __init__.py without | 587 Flag indicating an empty module (i.e. __init__.py without |
| 578 any contents) | 588 any contents) |
