Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html
eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html
- changeset 7693
- a51f82458a1b
- parent 7641
- 21ea4fd50b0a
- child 7698
- 12cb12380a6a
equal
deleted
inserted
replaced
| 7692:94f0017f9372 | 7693:a51f82458a1b |
|---|---|
| 77 </tr> | 77 </tr> |
| 78 <tr> | 78 <tr> |
| 79 <td><a href="#readmodule_ex">readmodule_ex</a></td> | 79 <td><a href="#readmodule_ex">readmodule_ex</a></td> |
| 80 <td>Read a module file and return a dictionary of classes.</td> | 80 <td>Read a module file and return a dictionary of classes.</td> |
| 81 </tr> | 81 </tr> |
| 82 <tr> | |
| 83 <td><a href="#scan">scan</a></td> | |
| 84 <td>Public method to scan the given source text.</td> | |
| 85 </tr> | |
| 82 </table> | 86 </table> |
| 83 <hr /> | 87 <hr /> |
| 84 <hr /> | 88 <hr /> |
| 85 <a NAME="Attribute" ID="Attribute"></a> | 89 <a NAME="Attribute" ID="Attribute"></a> |
| 86 <h2>Attribute</h2> | 90 <h2>Attribute</h2> |
| 630 module and return a dictionary with one entry for each class | 634 module and return a dictionary with one entry for each class |
| 631 found in the module. | 635 found in the module. |
| 632 </p> | 636 </p> |
| 633 <dl> | 637 <dl> |
| 634 | 638 |
| 635 <dt><i>module</i></dt> | 639 <dt><i>module</i> (str)</dt> |
| 636 <dd> | 640 <dd> |
| 637 name of the module file (string) | 641 name of the module file |
| 638 </dd> | 642 </dd> |
| 639 <dt><i>path</i></dt> | 643 <dt><i>path</i> (list of str)</dt> |
| 640 <dd> | 644 <dd> |
| 641 path the module should be searched in (list of strings) | 645 path the module should be searched in |
| 642 </dd> | 646 </dd> |
| 643 <dt><i>inpackage</i></dt> | 647 <dt><i>inpackage</i> (bool)</dt> |
| 644 <dd> | 648 <dd> |
| 645 flag indicating a module inside a package is scanned | 649 flag indicating a module inside a package is scanned |
| 646 </dd> | 650 </dd> |
| 647 <dt><i>isPyFile</i></dt> | 651 <dt><i>isPyFile</i> (bool)</dt> |
| 648 <dd> | 652 <dd> |
| 649 flag indicating a Python file (boolean) | 653 flag indicating a Python file |
| 650 </dd> | 654 </dd> |
| 651 </dl> | 655 </dl> |
| 652 <dl> | 656 <dl> |
| 653 <dt>Returns:</dt> | 657 <dt>Returns:</dt> |
| 654 <dd> | 658 <dd> |
| 655 the resulting dictionary | 659 the resulting dictionary |
| 656 </dd> | 660 </dd> |
| 657 </dl> | 661 </dl> |
| 662 <dl> | |
| 663 <dt>Return Type:</dt> | |
| 664 <dd> | |
| 665 dict | |
| 666 </dd> | |
| 667 </dl> | |
| 668 <div align="right"><a href="#top">Up</a></div> | |
| 669 <hr /> | |
| 670 <hr /> | |
| 671 <a NAME="scan" ID="scan"></a> | |
| 672 <h2>scan</h2> | |
| 673 <b>scan</b>(<i>src, file, module</i>) | |
| 674 | |
| 675 <p> | |
| 676 Public method to scan the given source text. | |
| 677 </p> | |
| 678 <dl> | |
| 679 | |
| 680 <dt><i>src</i> (str)</dt> | |
| 681 <dd> | |
| 682 source text to be scanned | |
| 683 </dd> | |
| 684 <dt><i>file</i> (str)</dt> | |
| 685 <dd> | |
| 686 file name associated with the source text | |
| 687 </dd> | |
| 688 <dt><i>module</i> (str)</dt> | |
| 689 <dd> | |
| 690 module name associated with the source text | |
| 691 </dd> | |
| 692 </dl> | |
| 693 <dl> | |
| 694 <dt>Returns:</dt> | |
| 695 <dd> | |
| 696 dictionary containing the extracted data | |
| 697 </dd> | |
| 698 </dl> | |
| 699 <dl> | |
| 700 <dt>Return Type:</dt> | |
| 701 <dd> | |
| 702 dict | |
| 703 </dd> | |
| 704 </dl> | |
| 658 <div align="right"><a href="#top">Up</a></div> | 705 <div align="right"><a href="#top">Up</a></div> |
| 659 <hr /> | 706 <hr /> |
| 660 </body></html> | 707 </body></html> |
