Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html
eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html
- changeset 7989
- a21d673a8f99
- parent 7273
- 391d6b7b1eff
- child 8215
- fc5d68a6889e
equal
deleted
inserted
replaced
| 7988:c4c17121eff8 | 7989:a21d673a8f99 |
|---|---|
| 237 <dd> | 237 <dd> |
| 238 documentation string (string) | 238 documentation string (string) |
| 239 </dd> | 239 </dd> |
| 240 </dl> | 240 </dl> |
| 241 <dl> | 241 <dl> |
| 242 <dt>Returns:</dt> | 242 <dt>Return:</dt> |
| 243 <dd> | 243 <dd> |
| 244 flag indicating the deprecation status (boolean) | 244 flag indicating the deprecation status (boolean) |
| 245 </dd> | 245 </dd> |
| 246 </dl> | 246 </dl> |
| 247 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> | 247 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> |
| 260 <dd> | 260 <dd> |
| 261 the entry to be formatted (string) | 261 the entry to be formatted (string) |
| 262 </dd> | 262 </dd> |
| 263 </dl> | 263 </dl> |
| 264 <dl> | 264 <dl> |
| 265 <dt>Returns:</dt> | 265 <dt>Return:</dt> |
| 266 <dd> | 266 <dd> |
| 267 formatted entry (string) | 267 formatted entry (string) |
| 268 </dd> | 268 </dd> |
| 269 </dl> | 269 </dl> |
| 270 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> | 270 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> |
| 280 <dd> | 280 <dd> |
| 281 The contents of the documentation string. (string) | 281 The contents of the documentation string. (string) |
| 282 </dd> | 282 </dd> |
| 283 </dl> | 283 </dl> |
| 284 <dl> | 284 <dl> |
| 285 <dt>Returns:</dt> | 285 <dt>Return:</dt> |
| 286 <dd> | 286 <dd> |
| 287 The formated contents of the documentation string. (string) | 287 The formatted contents of the documentation string. (string) |
| 288 </dd> | 288 </dd> |
| 289 </dl> | 289 </dl> |
| 290 <dl> | 290 <dl> |
| 291 | 291 |
| 292 <dt>Raises <b>TagError</b>:</dt> | 292 <dt>Raises <b>TagError</b>:</dt> |
| 302 <p> | 302 <p> |
| 303 Private method to generate the section listing all classes of the | 303 Private method to generate the section listing all classes of the |
| 304 module. | 304 module. |
| 305 </p> | 305 </p> |
| 306 <dl> | 306 <dl> |
| 307 <dt>Returns:</dt> | 307 <dt>Return:</dt> |
| 308 <dd> | 308 <dd> |
| 309 The classes list section. (string) | 309 The classes list section. (string) |
| 310 </dd> | 310 </dd> |
| 311 </dl> | 311 </dl> |
| 312 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> | 312 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> |
| 316 <p> | 316 <p> |
| 317 Private method to generate the document section with details about | 317 Private method to generate the document section with details about |
| 318 classes. | 318 classes. |
| 319 </p> | 319 </p> |
| 320 <dl> | 320 <dl> |
| 321 <dt>Returns:</dt> | 321 <dt>Return:</dt> |
| 322 <dd> | 322 <dd> |
| 323 The classes details section. (string) | 323 The classes details section. (string) |
| 324 </dd> | 324 </dd> |
| 325 </dl> | 325 </dl> |
| 326 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> | 326 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> |
| 341 <dd> | 341 <dd> |
| 342 The template to be used for the list. (string) | 342 The template to be used for the list. (string) |
| 343 </dd> | 343 </dd> |
| 344 </dl> | 344 </dl> |
| 345 <dl> | 345 <dl> |
| 346 <dt>Returns:</dt> | 346 <dt>Return:</dt> |
| 347 <dd> | 347 <dd> |
| 348 The list section. (string) | 348 The list section. (string) |
| 349 </dd> | 349 </dd> |
| 350 </dl> | 350 </dl> |
| 351 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> | 351 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> |
| 355 <p> | 355 <p> |
| 356 Private method to generate the section listing all functions of the | 356 Private method to generate the section listing all functions of the |
| 357 module. | 357 module. |
| 358 </p> | 358 </p> |
| 359 <dl> | 359 <dl> |
| 360 <dt>Returns:</dt> | 360 <dt>Return:</dt> |
| 361 <dd> | 361 <dd> |
| 362 The functions list section. (string) | 362 The functions list section. (string) |
| 363 </dd> | 363 </dd> |
| 364 </dl> | 364 </dl> |
| 365 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> | 365 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> |
| 369 <p> | 369 <p> |
| 370 Private method to generate the document section with details about | 370 Private method to generate the document section with details about |
| 371 functions. | 371 functions. |
| 372 </p> | 372 </p> |
| 373 <dl> | 373 <dl> |
| 374 <dt>Returns:</dt> | 374 <dt>Return:</dt> |
| 375 <dd> | 375 <dd> |
| 376 The functions details section. (string) | 376 The functions details section. (string) |
| 377 </dd> | 377 </dd> |
| 378 </dl> | 378 </dl> |
| 379 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> | 379 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> |
| 390 <dd> | 390 <dd> |
| 391 reference to a class object (Class) | 391 reference to a class object (Class) |
| 392 </dd> | 392 </dd> |
| 393 </dl> | 393 </dl> |
| 394 <dl> | 394 <dl> |
| 395 <dt>Returns:</dt> | 395 <dt>Return:</dt> |
| 396 <dd> | 396 <dd> |
| 397 The globals list section. (string) | 397 The globals list section. (string) |
| 398 </dd> | 398 </dd> |
| 399 </dl> | 399 </dl> |
| 400 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> | 400 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> |
| 419 <dd> | 419 <dd> |
| 420 suffix to be used for the QtHelp keywords (string) | 420 suffix to be used for the QtHelp keywords (string) |
| 421 </dd> | 421 </dd> |
| 422 </dl> | 422 </dl> |
| 423 <dl> | 423 <dl> |
| 424 <dt>Returns:</dt> | 424 <dt>Return:</dt> |
| 425 <dd> | 425 <dd> |
| 426 list section (string) | 426 list section (string) |
| 427 </dd> | 427 </dd> |
| 428 </dl> | 428 </dl> |
| 429 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> | 429 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> |
| 447 <dd> | 447 <dd> |
| 448 filter value designating the method types | 448 filter value designating the method types |
| 449 </dd> | 449 </dd> |
| 450 </dl> | 450 </dl> |
| 451 <dl> | 451 <dl> |
| 452 <dt>Returns:</dt> | 452 <dt>Return:</dt> |
| 453 <dd> | 453 <dd> |
| 454 method list and method details section (tuple of two string) | 454 method list and method details section (tuple of two string) |
| 455 </dd> | 455 </dd> |
| 456 </dl> | 456 </dl> |
| 457 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> | 457 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> |
| 485 flag indicating to include the __init__ method | 485 flag indicating to include the __init__ method |
| 486 (boolean) | 486 (boolean) |
| 487 </dd> | 487 </dd> |
| 488 </dl> | 488 </dl> |
| 489 <dl> | 489 <dl> |
| 490 <dt>Returns:</dt> | 490 <dt>Return:</dt> |
| 491 <dd> | 491 <dd> |
| 492 methods list section (string) | 492 methods list section (string) |
| 493 </dd> | 493 </dd> |
| 494 </dl> | 494 </dl> |
| 495 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> | 495 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> |
| 498 | 498 |
| 499 <p> | 499 <p> |
| 500 Private method to generate the body of the document. | 500 Private method to generate the body of the document. |
| 501 </p> | 501 </p> |
| 502 <dl> | 502 <dl> |
| 503 <dt>Returns:</dt> | 503 <dt>Return:</dt> |
| 504 <dd> | 504 <dd> |
| 505 The body of the document. (string) | 505 The body of the document. (string) |
| 506 </dd> | 506 </dd> |
| 507 </dl> | 507 </dl> |
| 508 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> | 508 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> |
| 523 <dd> | 523 <dd> |
| 524 A list of individual lines. (list of strings) | 524 A list of individual lines. (list of strings) |
| 525 </dd> | 525 </dd> |
| 526 </dl> | 526 </dl> |
| 527 <dl> | 527 <dl> |
| 528 <dt>Returns:</dt> | 528 <dt>Return:</dt> |
| 529 <dd> | 529 <dd> |
| 530 Ready formatted paragraphs. (string) | 530 Ready formatted paragraphs. (string) |
| 531 </dd> | 531 </dd> |
| 532 </dl> | 532 </dl> |
| 533 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> | 533 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> |
| 544 list containing the info for the parameter description | 544 list containing the info for the parameter description |
| 545 list section (list of lists with three elements) | 545 list section (list of lists with three elements) |
| 546 </dd> | 546 </dd> |
| 547 </dl> | 547 </dl> |
| 548 <dl> | 548 <dl> |
| 549 <dt>Returns:</dt> | 549 <dt>Return:</dt> |
| 550 <dd> | 550 <dd> |
| 551 formatted list section (string) | 551 formatted list section (string) |
| 552 </dd> | 552 </dd> |
| 553 </dl> | 553 </dl> |
| 554 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> | 554 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> |
| 574 name of the Ruby module containing the classes | 574 name of the Ruby module containing the classes |
| 575 (string) | 575 (string) |
| 576 </dd> | 576 </dd> |
| 577 </dl> | 577 </dl> |
| 578 <dl> | 578 <dl> |
| 579 <dt>Returns:</dt> | 579 <dt>Return:</dt> |
| 580 <dd> | 580 <dd> |
| 581 The list section. (string) | 581 The list section. (string) |
| 582 </dd> | 582 </dd> |
| 583 </dl> | 583 </dl> |
| 584 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> | 584 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> |
| 598 <dd> | 598 <dd> |
| 599 Name of the Ruby module containing the classes. (string) | 599 Name of the Ruby module containing the classes. (string) |
| 600 </dd> | 600 </dd> |
| 601 </dl> | 601 </dl> |
| 602 <dl> | 602 <dl> |
| 603 <dt>Returns:</dt> | 603 <dt>Return:</dt> |
| 604 <dd> | 604 <dd> |
| 605 The classes list and classes details section. | 605 The classes list and classes details section. |
| 606 (tuple of two string) | 606 (tuple of two string) |
| 607 </dd> | 607 </dd> |
| 608 </dl> | 608 </dl> |
| 613 <p> | 613 <p> |
| 614 Private method to generate the section listing all modules of the file | 614 Private method to generate the section listing all modules of the file |
| 615 (Ruby only). | 615 (Ruby only). |
| 616 </p> | 616 </p> |
| 617 <dl> | 617 <dl> |
| 618 <dt>Returns:</dt> | 618 <dt>Return:</dt> |
| 619 <dd> | 619 <dd> |
| 620 The modules list section. (string) | 620 The modules list section. (string) |
| 621 </dd> | 621 </dd> |
| 622 </dl> | 622 </dl> |
| 623 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> | 623 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> |
| 627 <p> | 627 <p> |
| 628 Private method to generate the document section with details about | 628 Private method to generate the document section with details about |
| 629 Ruby modules. | 629 Ruby modules. |
| 630 </p> | 630 </p> |
| 631 <dl> | 631 <dl> |
| 632 <dt>Returns:</dt> | 632 <dt>Return:</dt> |
| 633 <dd> | 633 <dd> |
| 634 The Ruby modules details section. (string) | 634 The Ruby modules details section. (string) |
| 635 </dd> | 635 </dd> |
| 636 </dl> | 636 </dl> |
| 637 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> | 637 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> |
| 652 <dd> | 652 <dd> |
| 653 The template to be used for the list. (string) | 653 The template to be used for the list. (string) |
| 654 </dd> | 654 </dd> |
| 655 </dl> | 655 </dl> |
| 656 <dl> | 656 <dl> |
| 657 <dt>Returns:</dt> | 657 <dt>Return:</dt> |
| 658 <dd> | 658 <dd> |
| 659 The list section. (string) | 659 The list section. (string) |
| 660 </dd> | 660 </dd> |
| 661 </dl> | 661 </dl> |
| 662 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> | 662 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> |
| 676 <dd> | 676 <dd> |
| 677 The documentation string. (string) | 677 The documentation string. (string) |
| 678 </dd> | 678 </dd> |
| 679 </dl> | 679 </dl> |
| 680 <dl> | 680 <dl> |
| 681 <dt>Returns:</dt> | 681 <dt>Return:</dt> |
| 682 <dd> | 682 <dd> |
| 683 The short description. (string) | 683 The short description. (string) |
| 684 </dd> | 684 </dd> |
| 685 </dl> | 685 </dl> |
| 686 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> | 686 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> |
| 696 <dd> | 696 <dd> |
| 697 One line of the description (string) | 697 One line of the description (string) |
| 698 </dd> | 698 </dd> |
| 699 </dl> | 699 </dl> |
| 700 <dl> | 700 <dl> |
| 701 <dt>Returns:</dt> | 701 <dt>Return:</dt> |
| 702 <dd> | 702 <dd> |
| 703 processed line with inline tags expanded (string) | 703 processed line with inline tags expanded (string) |
| 704 </dd> | 704 </dd> |
| 705 </dl> | 705 </dl> |
| 706 <dl> | 706 <dl> |
| 716 | 716 |
| 717 <p> | 717 <p> |
| 718 Public method used to get the description of the module. | 718 Public method used to get the description of the module. |
| 719 </p> | 719 </p> |
| 720 <dl> | 720 <dl> |
| 721 <dt>Returns:</dt> | 721 <dt>Return:</dt> |
| 722 <dd> | 722 <dd> |
| 723 The description of the module. (string) | 723 The description of the module. (string) |
| 724 </dd> | 724 </dd> |
| 725 </dl> | 725 </dl> |
| 726 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> | 726 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> |
| 729 | 729 |
| 730 <p> | 730 <p> |
| 731 Public method to generate the source code documentation. | 731 Public method to generate the source code documentation. |
| 732 </p> | 732 </p> |
| 733 <dl> | 733 <dl> |
| 734 <dt>Returns:</dt> | 734 <dt>Return:</dt> |
| 735 <dd> | 735 <dd> |
| 736 The source code documentation. (string) | 736 The source code documentation. (string) |
| 737 </dd> | 737 </dd> |
| 738 </dl> | 738 </dl> |
| 739 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> | 739 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> |
| 742 | 742 |
| 743 <p> | 743 <p> |
| 744 Public method to retrieve the parts for the QtHelp keywords section. | 744 Public method to retrieve the parts for the QtHelp keywords section. |
| 745 </p> | 745 </p> |
| 746 <dl> | 746 <dl> |
| 747 <dt>Returns:</dt> | 747 <dt>Return:</dt> |
| 748 <dd> | 748 <dd> |
| 749 list of tuples containing the name (string) and the ref | 749 list of tuples containing the name (string) and the ref |
| 750 (string). The ref is without the filename part. | 750 (string). The ref is without the filename part. |
| 751 </dd> | 751 </dd> |
| 752 </dl> | 752 </dl> |
| 757 <p> | 757 <p> |
| 758 Public method to determine, if the module contains any classes or | 758 Public method to determine, if the module contains any classes or |
| 759 functions. | 759 functions. |
| 760 </p> | 760 </p> |
| 761 <dl> | 761 <dl> |
| 762 <dt>Returns:</dt> | 762 <dt>Return:</dt> |
| 763 <dd> | 763 <dd> |
| 764 Flag indicating an empty module (i.e. __init__.py without | 764 Flag indicating an empty module (i.e. __init__.py without |
| 765 any contents) | 765 any contents) |
| 766 </dd> | 766 </dd> |
| 767 </dl> | 767 </dl> |
| 771 | 771 |
| 772 <p> | 772 <p> |
| 773 Public method used to get the module name. | 773 Public method used to get the module name. |
| 774 </p> | 774 </p> |
| 775 <dl> | 775 <dl> |
| 776 <dt>Returns:</dt> | 776 <dt>Return:</dt> |
| 777 <dd> | 777 <dd> |
| 778 The name of the module. (string) | 778 The name of the module. (string) |
| 779 </dd> | 779 </dd> |
| 780 </dl> | 780 </dl> |
| 781 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> | 781 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> |
| 788 <p> | 788 <p> |
| 789 The short description is just the first line of the modules | 789 The short description is just the first line of the modules |
| 790 description. | 790 description. |
| 791 </p> | 791 </p> |
| 792 <dl> | 792 <dl> |
| 793 <dt>Returns:</dt> | 793 <dt>Return:</dt> |
| 794 <dd> | 794 <dd> |
| 795 The short description of the module. (string) | 795 The short description of the module. (string) |
| 796 </dd> | 796 </dd> |
| 797 </dl> | 797 </dl> |
| 798 <div align="right"><a href="#top">Up</a></div> | 798 <div align="right"><a href="#top">Up</a></div> |
