Documentation/Source/eric5.Utilities.ModuleParser.html

changeset 1228
7afaf2fca55b
parent 945
8cd4d08fa9f6
child 1229
a8207dc73672
equal deleted inserted replaced
1227:c5db073a124f 1228:7afaf2fca55b
88 VisibilityBase 88 VisibilityBase
89 <h3>Class Attributes</h3> 89 <h3>Class Attributes</h3>
90 <table> 90 <table>
91 <tr><td>None</td></tr> 91 <tr><td>None</td></tr>
92 </table> 92 </table>
93 <h3>Class Methods</h3>
94 <table>
95 <tr><td>None</td></tr>
96 </table>
93 <h3>Methods</h3> 97 <h3>Methods</h3>
94 <table> 98 <table>
95 <tr> 99 <tr><td>None</td></tr>
96 <td><a href="#Attribute.__init__">Attribute</a></td> 100 </table>
97 <td>Constructor</td> 101 <h3>Static Methods</h3>
98 </tr> 102 <table>
103 <tr><td>None</td></tr>
99 </table> 104 </table>
100 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> 105 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a>
101 <h4>Attribute (Constructor)</h4> 106 <h4>Attribute (Constructor)</h4>
102 <b>Attribute</b>(<i>module, name, file, lineno, isSignal=False</i>) 107 <b>Attribute</b>(<i>module, name, file, lineno, isSignal=False</i>)
103 <p> 108 <p>
131 VisibilityBase 136 VisibilityBase
132 <h3>Class Attributes</h3> 137 <h3>Class Attributes</h3>
133 <table> 138 <table>
134 <tr><td>None</td></tr> 139 <tr><td>None</td></tr>
135 </table> 140 </table>
141 <h3>Class Methods</h3>
142 <table>
143 <tr><td>None</td></tr>
144 </table>
136 <h3>Methods</h3> 145 <h3>Methods</h3>
137 <table> 146 <table>
138 <tr> 147 <tr>
139 <td><a href="#Class.__init__">Class</a></td>
140 <td>Constructor</td>
141 </tr><tr>
142 <td><a href="#Class.addAttribute">addAttribute</a></td> 148 <td><a href="#Class.addAttribute">addAttribute</a></td>
143 <td>Public method to add information about attributes.</td> 149 <td>Public method to add information about attributes.</td>
144 </tr><tr> 150 </tr><tr>
145 <td><a href="#Class.addDescription">addDescription</a></td> 151 <td><a href="#Class.addDescription">addDescription</a></td>
146 <td>Public method to store the class docstring.</td> 152 <td>Public method to store the class docstring.</td>
158 <td>Public method to retrieve a method by name.</td> 164 <td>Public method to retrieve a method by name.</td>
159 </tr><tr> 165 </tr><tr>
160 <td><a href="#Class.setEndLine">setEndLine</a></td> 166 <td><a href="#Class.setEndLine">setEndLine</a></td>
161 <td>Public method to record the number of the last line of a class.</td> 167 <td>Public method to record the number of the last line of a class.</td>
162 </tr> 168 </tr>
169 </table>
170 <h3>Static Methods</h3>
171 <table>
172 <tr><td>None</td></tr>
163 </table> 173 </table>
164 <a NAME="Class.__init__" ID="Class.__init__"></a> 174 <a NAME="Class.__init__" ID="Class.__init__"></a>
165 <h4>Class (Constructor)</h4> 175 <h4>Class (Constructor)</h4>
166 <b>Class</b>(<i>module, name, super, file, lineno</i>) 176 <b>Class</b>(<i>module, name, super, file, lineno</i>)
167 <p> 177 <p>
283 </p> 293 </p>
284 <h3>Derived from</h3> 294 <h3>Derived from</h3>
285 VisibilityBase 295 VisibilityBase
286 <h3>Class Attributes</h3> 296 <h3>Class Attributes</h3>
287 <table> 297 <table>
298 <tr><td>Class</td></tr><tr><td>General</td></tr><tr><td>Static</td></tr>
299 </table>
300 <h3>Class Methods</h3>
301 <table>
288 <tr><td>None</td></tr> 302 <tr><td>None</td></tr>
289 </table> 303 </table>
290 <h3>Methods</h3> 304 <h3>Methods</h3>
291 <table> 305 <table>
292 <tr> 306 <tr>
293 <td><a href="#Function.__init__">Function</a></td>
294 <td>Constructor</td>
295 </tr><tr>
296 <td><a href="#Function.addDescription">addDescription</a></td> 307 <td><a href="#Function.addDescription">addDescription</a></td>
297 <td>Public method to store the functions docstring.</td> 308 <td>Public method to store the functions docstring.</td>
298 </tr> 309 </tr>
299 </table> 310 </table>
311 <h3>Static Methods</h3>
312 <table>
313 <tr><td>None</td></tr>
314 </table>
300 <a NAME="Function.__init__" ID="Function.__init__"></a> 315 <a NAME="Function.__init__" ID="Function.__init__"></a>
301 <h4>Function (Constructor)</h4> 316 <h4>Function (Constructor)</h4>
302 <b>Function</b>(<i>module, name, file, lineno, signature='', pyqtSignature=None</i>) 317 <b>Function</b>(<i>module, name, file, lineno, signature='', pyqtSignature=None, modifierType=General</i>)
303 <p> 318 <p>
304 Constructor 319 Constructor
305 </p><dl> 320 </p><dl>
306 <dt><i>module</i></dt> 321 <dt><i>module</i></dt>
307 <dd> 322 <dd>
319 <dd> 334 <dd>
320 the functions call signature (string) 335 the functions call signature (string)
321 </dd><dt><i>pyqtSignature</i></dt> 336 </dd><dt><i>pyqtSignature</i></dt>
322 <dd> 337 <dd>
323 the functions PyQt signature (string) 338 the functions PyQt signature (string)
339 </dd><dt><i>modifierType</i></dt>
340 <dd>
341 type of the function
324 </dd> 342 </dd>
325 </dl><a NAME="Function.addDescription" ID="Function.addDescription"></a> 343 </dl><a NAME="Function.addDescription" ID="Function.addDescription"></a>
326 <h4>Function.addDescription</h4> 344 <h4>Function.addDescription</h4>
327 <b>addDescription</b>(<i>description</i>) 345 <b>addDescription</b>(<i>description</i>)
328 <p> 346 <p>
344 object 362 object
345 <h3>Class Attributes</h3> 363 <h3>Class Attributes</h3>
346 <table> 364 <table>
347 <tr><td>None</td></tr> 365 <tr><td>None</td></tr>
348 </table> 366 </table>
367 <h3>Class Methods</h3>
368 <table>
369 <tr><td>None</td></tr>
370 </table>
349 <h3>Methods</h3> 371 <h3>Methods</h3>
350 <table> 372 <table>
351 <tr> 373 <tr>
352 <td><a href="#Module.__init__">Module</a></td>
353 <td>Constructor</td>
354 </tr><tr>
355 <td><a href="#Module.__py_scan">__py_scan</a></td> 374 <td><a href="#Module.__py_scan">__py_scan</a></td>
356 <td>Private method to scan the source text of a Python module and retrieve the relevant information.</td> 375 <td>Private method to scan the source text of a Python module and retrieve the relevant information.</td>
357 </tr><tr> 376 </tr><tr>
358 <td><a href="#Module.__py_setVisibility">__py_setVisibility</a></td> 377 <td><a href="#Module.__py_setVisibility">__py_setVisibility</a></td>
359 <td>Private method to set the visibility of an object.</td> 378 <td>Private method to set the visibility of an object.</td>
395 <td>Public method to get the type of the module's source.</td> 414 <td>Public method to get the type of the module's source.</td>
396 </tr><tr> 415 </tr><tr>
397 <td><a href="#Module.scan">scan</a></td> 416 <td><a href="#Module.scan">scan</a></td>
398 <td>Public method to scan the source text and retrieve the relevant information.</td> 417 <td>Public method to scan the source text and retrieve the relevant information.</td>
399 </tr> 418 </tr>
419 </table>
420 <h3>Static Methods</h3>
421 <table>
422 <tr><td>None</td></tr>
400 </table> 423 </table>
401 <a NAME="Module.__init__" ID="Module.__init__"></a> 424 <a NAME="Module.__init__" ID="Module.__init__"></a>
402 <h4>Module (Constructor)</h4> 425 <h4>Module (Constructor)</h4>
403 <b>Module</b>(<i>name, file=None, type=None</i>) 426 <b>Module</b>(<i>name, file=None, type=None</i>)
404 <p> 427 <p>
612 Class 635 Class
613 <h3>Class Attributes</h3> 636 <h3>Class Attributes</h3>
614 <table> 637 <table>
615 <tr><td>None</td></tr> 638 <tr><td>None</td></tr>
616 </table> 639 </table>
640 <h3>Class Methods</h3>
641 <table>
642 <tr><td>None</td></tr>
643 </table>
617 <h3>Methods</h3> 644 <h3>Methods</h3>
618 <table> 645 <table>
619 <tr> 646 <tr>
620 <td><a href="#RbModule.__init__">RbModule</a></td>
621 <td>Constructor</td>
622 </tr><tr>
623 <td><a href="#RbModule.addClass">addClass</a></td> 647 <td><a href="#RbModule.addClass">addClass</a></td>
624 <td>Public method to add information about a class.</td> 648 <td>Public method to add information about a class.</td>
625 </tr> 649 </tr>
650 </table>
651 <h3>Static Methods</h3>
652 <table>
653 <tr><td>None</td></tr>
626 </table> 654 </table>
627 <a NAME="RbModule.__init__" ID="RbModule.__init__"></a> 655 <a NAME="RbModule.__init__" ID="RbModule.__init__"></a>
628 <h4>RbModule (Constructor)</h4> 656 <h4>RbModule (Constructor)</h4>
629 <b>RbModule</b>(<i>module, name, file, lineno</i>) 657 <b>RbModule</b>(<i>module, name, file, lineno</i>)
630 <p> 658 <p>
668 object 696 object
669 <h3>Class Attributes</h3> 697 <h3>Class Attributes</h3>
670 <table> 698 <table>
671 <tr><td>None</td></tr> 699 <tr><td>None</td></tr>
672 </table> 700 </table>
701 <h3>Class Methods</h3>
702 <table>
703 <tr><td>None</td></tr>
704 </table>
673 <h3>Methods</h3> 705 <h3>Methods</h3>
674 <table> 706 <table>
675 <tr> 707 <tr>
676 <td><a href="#VisibilityBase.isPrivate">isPrivate</a></td> 708 <td><a href="#VisibilityBase.isPrivate">isPrivate</a></td>
677 <td>Public method to check, if the visibility is Private.</td> 709 <td>Public method to check, if the visibility is Private.</td>
689 <td>Public method to set the visibility to Protected.</td> 721 <td>Public method to set the visibility to Protected.</td>
690 </tr><tr> 722 </tr><tr>
691 <td><a href="#VisibilityBase.setPublic">setPublic</a></td> 723 <td><a href="#VisibilityBase.setPublic">setPublic</a></td>
692 <td>Public method to set the visibility to Public.</td> 724 <td>Public method to set the visibility to Public.</td>
693 </tr> 725 </tr>
726 </table>
727 <h3>Static Methods</h3>
728 <table>
729 <tr><td>None</td></tr>
694 </table> 730 </table>
695 <a NAME="VisibilityBase.isPrivate" ID="VisibilityBase.isPrivate"></a> 731 <a NAME="VisibilityBase.isPrivate" ID="VisibilityBase.isPrivate"></a>
696 <h4>VisibilityBase.isPrivate</h4> 732 <h4>VisibilityBase.isPrivate</h4>
697 <b>isPrivate</b>(<i></i>) 733 <b>isPrivate</b>(<i></i>)
698 <p> 734 <p>

eric ide

mercurial