Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html

Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.DocumentationTools.ModuleDocumentor</h1> 23 <h1>eric5.DocumentationTools.ModuleDocumentor</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;. 25 Module implementing the builtin documentation generator.
26 </p><p> 26 </p><p>
27 &#84;&#104;&#101; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#116; &#112;&#97;&#114;&#116;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#97;&#114;&#101; &#97;&#115;&#115;&#101;&#109;&#98;&#108;&#101;&#100; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#112;&#97;&#114;&#115;&#101;&#100; 27 The different parts of the module document are assembled from the parsed
28 &#80;y&#116;&#104;&#111;&#110; &#102;&#105;&#108;&#101;. &#84;&#104;&#101; &#97;&#112;&#112;&#101;&#97;&#114;&#97;&#110;&#99;&#101; &#105;&#115; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#101;&#100; &#98;y &#115;&#101;v&#101;&#114;&#97;&#108; &#116;&#101;&#109;&#112;&#108;&#97;&#116;&#101;&#115; &#100;&#101;&#102;&#105;&#110;&#101;&#100; w&#105;&#116;&#104;&#105;&#110; 28 Python file. The appearance is determined by several templates defined within
29 &#116;&#104;&#105;&#115; &#109;&#111;&#100;&#117;&#108;&#101;. 29 this module.
30 </p> 30 </p>
31 <h3>Global Attributes</h3> 31 <h3>Global Attributes</h3>
32 <table> 32 <table>
33 <tr><td>_event</td></tr><tr><td>_signal</td></tr> 33 <tr><td>_event</td></tr><tr><td>_signal</td></tr>
34 </table> 34 </table>
35 <h3>Classes</h3> 35 <h3>Classes</h3>
36 <table> 36 <table>
37 <tr> 37 <tr>
38 <td><a href="#ModuleDocument">ModuleDocument</a></td> 38 <td><a href="#ModuleDocument">ModuleDocument</a></td>
39 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.</td> 39 <td>Class implementing the builtin documentation generator.</td>
40 </tr><tr> 40 </tr><tr>
41 <td><a href="#TagError">TagError</a></td> 41 <td><a href="#TagError">TagError</a></td>
42 <td>&#69;x&#99;&#101;&#112;&#116;&#105;&#111;&#110; &#99;&#108;&#97;&#115;&#115; &#114;&#97;&#105;&#115;&#101;&#100;, &#105;&#102; &#97;&#110; &#105;&#110;v&#97;&#108;&#105;&#100; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#116;&#97;&#103; w&#97;&#115; &#102;&#111;&#117;&#110;&#100;.</td> 42 <td>Exception class raised, if an invalid documentation tag was found.</td>
43 </tr> 43 </tr>
44 </table> 44 </table>
45 <h3>Functions</h3> 45 <h3>Functions</h3>
46 <table> 46 <table>
47 <tr><td>None</td></tr> 47 <tr><td>None</td></tr>
48 </table> 48 </table>
49 <hr /><hr /> 49 <hr /><hr />
50 <a NAME="ModuleDocument" ID="ModuleDocument"></a> 50 <a NAME="ModuleDocument" ID="ModuleDocument"></a>
51 <h2>ModuleDocument</h2> 51 <h2>ModuleDocument</h2>
52 <p> 52 <p>
53 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;. 53 Class implementing the builtin documentation generator.
54 </p> 54 </p>
55 <h3>Derived from</h3> 55 <h3>Derived from</h3>
56 object 56 object
57 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58 <table> 58 <table>
60 </table> 60 </table>
61 <h3>Methods</h3> 61 <h3>Methods</h3>
62 <table> 62 <table>
63 <tr> 63 <tr>
64 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td> 64 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td>
65 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 65 <td>Constructor</td>
66 </tr><tr> 66 </tr><tr>
67 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td> 67 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td>
68 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#115; &#97; &#100;&#101;&#112;&#114;&#101;&#99;&#97;&#116;&#101;&#100; &#102;&#108;&#97;&#103;.</td> 68 <td>Private method to check, if the object to be documented contains a deprecated flag.</td>
69 </tr><tr> 69 </tr><tr>
70 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td> 70 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td>
71 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#102;&#111;&#114;&#109;&#97;&#116; &#97; &#99;&#114;&#111;&#115;&#115; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#101;&#110;&#116;&#114;y.</td> 71 <td>Private method to format a cross reference entry.</td>
72 </tr><tr> 72 </tr><tr>
73 <td><a href="#ModuleDocument.__formatDescription">__formatDescription</a></td> 73 <td><a href="#ModuleDocument.__formatDescription">__formatDescription</a></td>
74 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#102;&#111;&#114;&#109;&#97;&#116; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103;.</td> 74 <td>Private method to format the contents of the documentation string.</td>
75 </tr><tr> 75 </tr><tr>
76 <td><a href="#ModuleDocument.__genClassListSection">__genClassListSection</a></td> 76 <td><a href="#ModuleDocument.__genClassListSection">__genClassListSection</a></td>
77 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#108;&#105;&#115;&#116;&#105;&#110;&#103; &#97;&#108;&#108; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.</td> 77 <td>Private method to generate the section listing all classes of the module.</td>
78 </tr><tr> 78 </tr><tr>
79 <td><a href="#ModuleDocument.__genClassesSection">__genClassesSection</a></td> 79 <td><a href="#ModuleDocument.__genClassesSection">__genClassesSection</a></td>
80 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; w&#105;&#116;&#104; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#97;&#98;&#111;&#117;&#116; &#99;&#108;&#97;&#115;&#115;&#101;&#115;.</td> 80 <td>Private method to generate the document section with details about classes.</td>
81 </tr><tr> 81 </tr><tr>
82 <td><a href="#ModuleDocument.__genDescriptionListSection">__genDescriptionListSection</a></td> 82 <td><a href="#ModuleDocument.__genDescriptionListSection">__genDescriptionListSection</a></td>
83 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;.</td> 83 <td>Private method to generate the list section of a description.</td>
84 </tr><tr> 84 </tr><tr>
85 <td><a href="#ModuleDocument.__genFunctionListSection">__genFunctionListSection</a></td> 85 <td><a href="#ModuleDocument.__genFunctionListSection">__genFunctionListSection</a></td>
86 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#108;&#105;&#115;&#116;&#105;&#110;&#103; &#97;&#108;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.</td> 86 <td>Private method to generate the section listing all functions of the module.</td>
87 </tr><tr> 87 </tr><tr>
88 <td><a href="#ModuleDocument.__genFunctionsSection">__genFunctionsSection</a></td> 88 <td><a href="#ModuleDocument.__genFunctionsSection">__genFunctionsSection</a></td>
89 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; w&#105;&#116;&#104; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#97;&#98;&#111;&#117;&#116; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;.</td> 89 <td>Private method to generate the document section with details about functions.</td>
90 </tr><tr> 90 </tr><tr>
91 <td><a href="#ModuleDocument.__genGlobalsListSection">__genGlobalsListSection</a></td> 91 <td><a href="#ModuleDocument.__genGlobalsListSection">__genGlobalsListSection</a></td>
92 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#108;&#105;&#115;&#116;&#105;&#110;&#103; &#97;&#108;&#108; &#103;&#108;&#111;&#98;&#97;&#108; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.</td> 92 <td>Private method to generate the section listing all global attributes of the module.</td>
93 </tr><tr> 93 </tr><tr>
94 <td><a href="#ModuleDocument.__genListSection">__genListSection</a></td> 94 <td><a href="#ModuleDocument.__genListSection">__genListSection</a></td>
95 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.</td> 95 <td>Private method to generate a list section of the document.</td>
96 </tr><tr> 96 </tr><tr>
97 <td><a href="#ModuleDocument.__genMethodSection">__genMethodSection</a></td> 97 <td><a href="#ModuleDocument.__genMethodSection">__genMethodSection</a></td>
98 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;.</td> 98 <td>Private method to generate the method details section.</td>
99 </tr><tr> 99 </tr><tr>
100 <td><a href="#ModuleDocument.__genMethodsListSection">__genMethodsListSection</a></td> 100 <td><a href="#ModuleDocument.__genMethodsListSection">__genMethodsListSection</a></td>
101 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#109;&#101;&#116;&#104;&#111;&#100;&#115; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#99;&#108;&#97;&#115;&#115;.</td> 101 <td>Private method to generate the methods list section of a class.</td>
102 </tr><tr> 102 </tr><tr>
103 <td><a href="#ModuleDocument.__genModuleSection">__genModuleSection</a></td> 103 <td><a href="#ModuleDocument.__genModuleSection">__genModuleSection</a></td>
104 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#98;&#111;&#100;y &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.</td> 104 <td>Private method to generate the body of the document.</td>
105 </tr><tr> 105 </tr><tr>
106 <td><a href="#ModuleDocument.__genParagraphs">__genParagraphs</a></td> 106 <td><a href="#ModuleDocument.__genParagraphs">__genParagraphs</a></td>
107 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#115;&#115;&#101;&#109;&#98;&#108;&#101; &#116;&#104;&#101; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;v&#101; &#112;&#97;&#114;&#97;&#103;&#114;&#97;&#112;&#104;&#115; &#111;&#102; &#97; &#100;&#111;&#99;&#115;&#116;&#114;&#105;&#110;&#103;.</td> 107 <td>Private method to assemble the descriptive paragraphs of a docstring.</td>
108 </tr><tr> 108 </tr><tr>
109 <td><a href="#ModuleDocument.__genParamDescriptionListSection">__genParamDescriptionListSection</a></td> 109 <td><a href="#ModuleDocument.__genParamDescriptionListSection">__genParamDescriptionListSection</a></td>
110 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;.</td> 110 <td>Private method to generate the list section of a description.</td>
111 </tr><tr> 111 </tr><tr>
112 <td><a href="#ModuleDocument.__genRbModulesClassesListSection">__genRbModulesClassesListSection</a></td> 112 <td><a href="#ModuleDocument.__genRbModulesClassesListSection">__genRbModulesClassesListSection</a></td>
113 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101;.</td> 113 <td>Private method to generate the classes list section of a Ruby module.</td>
114 </tr><tr> 114 </tr><tr>
115 <td><a href="#ModuleDocument.__genRbModulesClassesSection">__genRbModulesClassesSection</a></td> 115 <td><a href="#ModuleDocument.__genRbModulesClassesSection">__genRbModulesClassesSection</a></td>
116 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;.</td> 116 <td>Private method to generate the Ruby module classes details section.</td>
117 </tr><tr> 117 </tr><tr>
118 <td><a href="#ModuleDocument.__genRbModulesListSection">__genRbModulesListSection</a></td> 118 <td><a href="#ModuleDocument.__genRbModulesListSection">__genRbModulesListSection</a></td>
119 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#108;&#105;&#115;&#116;&#105;&#110;&#103; &#97;&#108;&#108; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; (&#82;&#117;&#98;y &#111;&#110;&#108;y).</td> 119 <td>Private method to generate the section listing all modules of the file (Ruby only).</td>
120 </tr><tr> 120 </tr><tr>
121 <td><a href="#ModuleDocument.__genRbModulesSection">__genRbModulesSection</a></td> 121 <td><a href="#ModuleDocument.__genRbModulesSection">__genRbModulesSection</a></td>
122 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; w&#105;&#116;&#104; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#97;&#98;&#111;&#117;&#116; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101;&#115;.</td> 122 <td>Private method to generate the document section with details about Ruby modules.</td>
123 </tr><tr> 123 </tr><tr>
124 <td><a href="#ModuleDocument.__genSeeListSection">__genSeeListSection</a></td> 124 <td><a href="#ModuleDocument.__genSeeListSection">__genSeeListSection</a></td>
125 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; "&#115;&#101;&#101; &#97;&#108;&#115;&#111;" &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;.</td> 125 <td>Private method to generate the "see also" list section of a description.</td>
126 </tr><tr> 126 </tr><tr>
127 <td><a href="#ModuleDocument.__getShortDescription">__getShortDescription</a></td> 127 <td><a href="#ModuleDocument.__getShortDescription">__getShortDescription</a></td>
128 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#101; &#116;&#104;&#101; &#115;&#104;&#111;&#114;&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#111;&#102; &#97;&#110; &#111;&#98;&#106;&#101;&#99;&#116;.</td> 128 <td>Private method to determine the short description of an object.</td>
129 </tr><tr> 129 </tr><tr>
130 <td><a href="#ModuleDocument.__processInlineTags">__processInlineTags</a></td> 130 <td><a href="#ModuleDocument.__processInlineTags">__processInlineTags</a></td>
131 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#105;&#110;&#108;&#105;&#110;&#101; &#116;&#97;&#103;&#115;.</td> 131 <td>Private method to process inline tags.</td>
132 </tr><tr> 132 </tr><tr>
133 <td><a href="#ModuleDocument.description">description</a></td> 133 <td><a href="#ModuleDocument.description">description</a></td>
134 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.</td> 134 <td>Public method used to get the description of the module.</td>
135 </tr><tr> 135 </tr><tr>
136 <td><a href="#ModuleDocument.genDocument">genDocument</a></td> 136 <td><a href="#ModuleDocument.genDocument">genDocument</a></td>
137 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;.</td> 137 <td>Public method to generate the source code documentation.</td>
138 </tr><tr> 138 </tr><tr>
139 <td><a href="#ModuleDocument.getQtHelpKeywords">getQtHelpKeywords</a></td> 139 <td><a href="#ModuleDocument.getQtHelpKeywords">getQtHelpKeywords</a></td>
140 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#112;&#97;&#114;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#107;&#101;yw&#111;&#114;&#100;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;.</td> 140 <td>Public method to retrieve the parts for the QtHelp keywords section.</td>
141 </tr><tr> 141 </tr><tr>
142 <td><a href="#ModuleDocument.isEmpty">isEmpty</a></td> 142 <td><a href="#ModuleDocument.isEmpty">isEmpty</a></td>
143 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#101;, &#105;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#115; &#97;&#110;y &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#111;&#114; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;.</td> 143 <td>Public method to determine, if the module contains any classes or functions.</td>
144 </tr><tr> 144 </tr><tr>
145 <td><a href="#ModuleDocument.name">name</a></td> 145 <td><a href="#ModuleDocument.name">name</a></td>
146 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#110;&#97;&#109;&#101;.</td> 146 <td>Public method used to get the module name.</td>
147 </tr><tr> 147 </tr><tr>
148 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td> 148 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td>
149 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#115;&#104;&#111;&#114;&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.</td> 149 <td>Public method used to get the short description of the module.</td>
150 </tr> 150 </tr>
151 </table> 151 </table>
152 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> 152 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a>
153 <h4>ModuleDocument (Constructor)</h4> 153 <h4>ModuleDocument (Constructor)</h4>
154 <b>ModuleDocument</b>(<i>module, colors, stylesheet = None</i>) 154 <b>ModuleDocument</b>(<i>module, colors, stylesheet = None</i>)
155 <p> 155 <p>
156 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 156 Constructor
157 </p><dl> 157 </p><dl>
158 <dt><i>module</i></dt> 158 <dt><i>module</i></dt>
159 <dd> 159 <dd>
160 &#116;&#104;&#101; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#114;&#115;&#101;&#100; &#80;y&#116;&#104;&#111;&#110; &#102;&#105;&#108;&#101; 160 the information of the parsed Python file
161 </dd><dt><i>colors</i></dt> 161 </dd><dt><i>colors</i></dt>
162 <dd> 162 <dd>
163 &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#115;&#112;&#101;&#99;&#105;&#102;y&#105;&#110;&#103; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#99;&#111;&#108;&#111;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; 163 dictionary specifying the various colors for the output
164 (&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 164 (dictionary of strings)
165 </dd><dt><i>stylesheet</i></dt> 165 </dd><dt><i>stylesheet</i></dt>
166 <dd> 166 <dd>
167 &#116;&#104;&#101; &#115;&#116;y&#108;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#112;&#97;&#103;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;) 167 the style to be used for the generated pages (string)
168 </dd> 168 </dd>
169 </dl><a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a> 169 </dl><a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a>
170 <h4>ModuleDocument.__checkDeprecated</h4> 170 <h4>ModuleDocument.__checkDeprecated</h4>
171 <b>__checkDeprecated</b>(<i>descr</i>) 171 <b>__checkDeprecated</b>(<i>descr</i>)
172 <p> 172 <p>
173 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#115; &#97; 173 Private method to check, if the object to be documented contains a
174 &#100;&#101;&#112;&#114;&#101;&#99;&#97;&#116;&#101;&#100; &#102;&#108;&#97;&#103;. 174 deprecated flag.
175 </p><dl> 175 </p><dl>
176 <dt><i>desc</i></dt> 176 <dt><i>desc</i></dt>
177 <dd> 177 <dd>
178 &#84;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103;. (&#115;&#116;&#114;&#105;&#110;&#103;) 178 The documentation string. (string)
179 </dd> 179 </dd>
180 </dl><dl> 180 </dl><dl>
181 <dt>Returns:</dt> 181 <dt>Returns:</dt>
182 <dd> 182 <dd>
183 &#70;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#101;&#112;&#114;&#101;&#99;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#97;&#116;&#117;&#115;. (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 183 Flag indicating the deprecation status. (boolean)
184 </dd> 184 </dd>
185 </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> 185 </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a>
186 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> 186 <h4>ModuleDocument.__formatCrossReferenceEntry</h4>
187 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) 187 <b>__formatCrossReferenceEntry</b>(<i>entry</i>)
188 <p> 188 <p>
189 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#102;&#111;&#114;&#109;&#97;&#116; &#97; &#99;&#114;&#111;&#115;&#115; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#101;&#110;&#116;&#114;y. 189 Private method to format a cross reference entry.
190 </p><p> 190 </p><p>
191 &#84;&#104;&#105;&#115; &#99;&#114;&#111;&#115;&#115; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#101;&#110;&#116;&#114;y &#108;&#111;&#111;&#107;&#115; &#108;&#105;&#107;&#101; "&#112;&#97;&#99;&#107;&#97;&#103;&#101;.&#109;&#111;&#100;&#117;&#108;&#101;#&#109;&#101;&#109;&#98;&#101;&#114; &#108;&#97;&#98;&#101;&#108;". 191 This cross reference entry looks like "package.module#member label".
192 </p><dl> 192 </p><dl>
193 <dt><i>entry</i></dt> 193 <dt><i>entry</i></dt>
194 <dd> 194 <dd>
195 &#116;&#104;&#101; &#101;&#110;&#116;&#114;y &#116;&#111; &#98;&#101; &#102;&#111;&#114;&#109;&#97;&#116;&#116;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;) 195 the entry to be formatted (string)
196 </dd> 196 </dd>
197 </dl><dl> 197 </dl><dl>
198 <dt>Returns:</dt> 198 <dt>Returns:</dt>
199 <dd> 199 <dd>
200 &#102;&#111;&#114;&#109;&#97;&#116;&#116;&#101;&#100; &#101;&#110;&#116;&#114;y (&#115;&#116;&#114;&#105;&#110;&#103;) 200 formatted entry (string)
201 </dd> 201 </dd>
202 </dl><a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> 202 </dl><a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a>
203 <h4>ModuleDocument.__formatDescription</h4> 203 <h4>ModuleDocument.__formatDescription</h4>
204 <b>__formatDescription</b>(<i>descr</i>) 204 <b>__formatDescription</b>(<i>descr</i>)
205 <p> 205 <p>
206 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#102;&#111;&#114;&#109;&#97;&#116; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103;. 206 Private method to format the contents of the documentation string.
207 </p><dl> 207 </p><dl>
208 <dt><i>descr</i></dt> 208 <dt><i>descr</i></dt>
209 <dd> 209 <dd>
210 &#84;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103;. (&#115;&#116;&#114;&#105;&#110;&#103;) 210 The contents of the documentation string. (string)
211 </dd> 211 </dd>
212 </dl><dl> 212 </dl><dl>
213 <dt>Returns:</dt> 213 <dt>Returns:</dt>
214 <dd> 214 <dd>
215 &#84;&#104;&#101; &#102;&#111;&#114;&#109;&#97;&#116;&#101;&#100; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103;. (&#115;&#116;&#114;&#105;&#110;&#103;) 215 The formated contents of the documentation string. (string)
216 </dd> 216 </dd>
217 </dl><dl> 217 </dl><dl>
218 <dt>Raises <b>TagError</b>:</dt> 218 <dt>Raises <b>TagError</b>:</dt>
219 <dd> 219 <dd>
220 &#65; &#116;&#97;&#103; &#100;&#111;&#101;&#115;&#110;'&#116; &#104;&#97;v&#101; &#116;&#104;&#101; &#99;&#111;&#114;&#114;&#101;&#99;&#116; &#110;&#117;&#109;&#98;&#101;&#114; 220 A tag doesn't have the correct number
221 &#111;&#102; &#97;&#114;&#103;&#117;&#109;&#101;&#110;&#116;&#115;. 221 of arguments.
222 </dd> 222 </dd>
223 </dl><a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> 223 </dl><a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a>
224 <h4>ModuleDocument.__genClassListSection</h4> 224 <h4>ModuleDocument.__genClassListSection</h4>
225 <b>__genClassListSection</b>(<i></i>) 225 <b>__genClassListSection</b>(<i></i>)
226 <p> 226 <p>
227 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#108;&#105;&#115;&#116;&#105;&#110;&#103; &#97;&#108;&#108; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;. 227 Private method to generate the section listing all classes of the module.
228 </p><dl> 228 </p><dl>
229 <dt>Returns:</dt> 229 <dt>Returns:</dt>
230 <dd> 230 <dd>
231 &#84;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 231 The classes list section. (string)
232 </dd> 232 </dd>
233 </dl><a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> 233 </dl><a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a>
234 <h4>ModuleDocument.__genClassesSection</h4> 234 <h4>ModuleDocument.__genClassesSection</h4>
235 <b>__genClassesSection</b>(<i></i>) 235 <b>__genClassesSection</b>(<i></i>)
236 <p> 236 <p>
237 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; w&#105;&#116;&#104; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#97;&#98;&#111;&#117;&#116; &#99;&#108;&#97;&#115;&#115;&#101;&#115;. 237 Private method to generate the document section with details about classes.
238 </p><dl> 238 </p><dl>
239 <dt>Returns:</dt> 239 <dt>Returns:</dt>
240 <dd> 240 <dd>
241 &#84;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 241 The classes details section. (string)
242 </dd> 242 </dd>
243 </dl><a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> 243 </dl><a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a>
244 <h4>ModuleDocument.__genDescriptionListSection</h4> 244 <h4>ModuleDocument.__genDescriptionListSection</h4>
245 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>) 245 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>)
246 <p> 246 <p>
247 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;. 247 Private method to generate the list section of a description.
248 </p><dl> 248 </p><dl>
249 <dt><i>dictionary</i></dt> 249 <dt><i>dictionary</i></dt>
250 <dd> 250 <dd>
251 &#68;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#102;&#111; &#102;&#111;&#114; &#116;&#104;&#101; 251 Dictionary containing the info for the
252 &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. 252 list section.
253 </dd><dt><i>template</i></dt> 253 </dd><dt><i>template</i></dt>
254 <dd> 254 <dd>
255 &#84;&#104;&#101; &#116;&#101;&#109;&#112;&#108;&#97;&#116;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#108;&#105;&#115;&#116;. (&#115;&#116;&#114;&#105;&#110;&#103;) 255 The template to be used for the list. (string)
256 </dd> 256 </dd>
257 </dl><dl> 257 </dl><dl>
258 <dt>Returns:</dt> 258 <dt>Returns:</dt>
259 <dd> 259 <dd>
260 &#84;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 260 The list section. (string)
261 </dd> 261 </dd>
262 </dl><a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> 262 </dl><a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a>
263 <h4>ModuleDocument.__genFunctionListSection</h4> 263 <h4>ModuleDocument.__genFunctionListSection</h4>
264 <b>__genFunctionListSection</b>(<i></i>) 264 <b>__genFunctionListSection</b>(<i></i>)
265 <p> 265 <p>
266 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#108;&#105;&#115;&#116;&#105;&#110;&#103; &#97;&#108;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;. 266 Private method to generate the section listing all functions of the module.
267 </p><dl> 267 </p><dl>
268 <dt>Returns:</dt> 268 <dt>Returns:</dt>
269 <dd> 269 <dd>
270 &#84;&#104;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 270 The functions list section. (string)
271 </dd> 271 </dd>
272 </dl><a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> 272 </dl><a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a>
273 <h4>ModuleDocument.__genFunctionsSection</h4> 273 <h4>ModuleDocument.__genFunctionsSection</h4>
274 <b>__genFunctionsSection</b>(<i></i>) 274 <b>__genFunctionsSection</b>(<i></i>)
275 <p> 275 <p>
276 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; w&#105;&#116;&#104; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#97;&#98;&#111;&#117;&#116; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;. 276 Private method to generate the document section with details about functions.
277 </p><dl> 277 </p><dl>
278 <dt>Returns:</dt> 278 <dt>Returns:</dt>
279 <dd> 279 <dd>
280 &#84;&#104;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 280 The functions details section. (string)
281 </dd> 281 </dd>
282 </dl><a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> 282 </dl><a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a>
283 <h4>ModuleDocument.__genGlobalsListSection</h4> 283 <h4>ModuleDocument.__genGlobalsListSection</h4>
284 <b>__genGlobalsListSection</b>(<i>class_ = None</i>) 284 <b>__genGlobalsListSection</b>(<i>class_ = None</i>)
285 <p> 285 <p>
286 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#108;&#105;&#115;&#116;&#105;&#110;&#103; &#97;&#108;&#108; &#103;&#108;&#111;&#98;&#97;&#108; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115; &#111;&#102; 286 Private method to generate the section listing all global attributes of
287 &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;. 287 the module.
288 </p><dl> 288 </p><dl>
289 <dt><i>class_</i></dt> 289 <dt><i>class_</i></dt>
290 <dd> 290 <dd>
291 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#97; &#99;&#108;&#97;&#115;&#115; &#111;&#98;&#106;&#101;&#99;&#116; (&#67;&#108;&#97;&#115;&#115;) 291 reference to a class object (Class)
292 </dd> 292 </dd>
293 </dl><dl> 293 </dl><dl>
294 <dt>Returns:</dt> 294 <dt>Returns:</dt>
295 <dd> 295 <dd>
296 &#84;&#104;&#101; &#103;&#108;&#111;&#98;&#97;&#108;&#115; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 296 The globals list section. (string)
297 </dd> 297 </dd>
298 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> 298 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a>
299 <h4>ModuleDocument.__genListSection</h4> 299 <h4>ModuleDocument.__genListSection</h4>
300 <b>__genListSection</b>(<i>names, dict, kwSuffix = ""</i>) 300 <b>__genListSection</b>(<i>names, dict, kwSuffix = ""</i>)
301 <p> 301 <p>
302 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;. 302 Private method to generate a list section of the document.
303 </p><dl> 303 </p><dl>
304 <dt><i>names</i></dt> 304 <dt><i>names</i></dt>
305 <dd> 305 <dd>
306 &#84;&#104;&#101; &#110;&#97;&#109;&#101;&#115; &#116;&#111; &#97;&#112;&#112;&#101;&#97;&#114; &#105;&#110; &#116;&#104;&#101; &#108;&#105;&#115;&#116;. (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 306 The names to appear in the list. (list of strings)
307 </dd><dt><i>dict</i></dt> 307 </dd><dt><i>dict</i></dt>
308 <dd> 308 <dd>
309 &#65; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#97;&#108;&#108; &#114;&#101;&#108;&#101;v&#97;&#110;&#116; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;. 309 A dictionary containing all relevant information.
310 </dd><dt><i>kwSuffix</i></dt> 310 </dd><dt><i>kwSuffix</i></dt>
311 <dd> 311 <dd>
312 &#115;&#117;&#102;&#102;&#105;x &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#107;&#101;yw&#111;&#114;&#100;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;) 312 suffix to be used for the QtHelp keywords (string)
313 </dd> 313 </dd>
314 </dl><dl> 314 </dl><dl>
315 <dt>Returns:</dt> 315 <dt>Returns:</dt>
316 <dd> 316 <dd>
317 &#84;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 317 The list section. (string)
318 </dd> 318 </dd>
319 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> 319 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a>
320 <h4>ModuleDocument.__genMethodSection</h4> 320 <h4>ModuleDocument.__genMethodSection</h4>
321 <b>__genMethodSection</b>(<i>obj, className</i>) 321 <b>__genMethodSection</b>(<i>obj, className</i>)
322 <p> 322 <p>
323 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. 323 Private method to generate the method details section.
324 </p><dl> 324 </p><dl>
325 <dt><i>obj</i></dt> 325 <dt><i>obj</i></dt>
326 <dd> 326 <dd>
327 &#82;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#111;&#98;&#106;&#101;&#99;&#116; &#98;&#101;&#105;&#110;&#103; &#102;&#111;&#114;&#109;&#97;&#116;&#116;&#101;&#100;. 327 Reference to the object being formatted.
328 </dd><dt><i>className</i></dt> 328 </dd><dt><i>className</i></dt>
329 <dd> 329 <dd>
330 &#78;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#109;&#101;&#116;&#104;&#111;&#100;. (&#115;&#116;&#114;&#105;&#110;&#103;) 330 Name of the class containing the method. (string)
331 </dd> 331 </dd>
332 </dl><dl> 332 </dl><dl>
333 <dt>Returns:</dt> 333 <dt>Returns:</dt>
334 <dd> 334 <dd>
335 &#84;&#104;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#108;&#105;&#115;&#116; &#97;&#110;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;w&#111; &#115;&#116;&#114;&#105;&#110;&#103;) 335 The method list and method details section. (tuple of two string)
336 </dd> 336 </dd>
337 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> 337 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a>
338 <h4>ModuleDocument.__genMethodsListSection</h4> 338 <h4>ModuleDocument.__genMethodsListSection</h4>
339 <b>__genMethodsListSection</b>(<i>names, dict, className, clsName</i>) 339 <b>__genMethodsListSection</b>(<i>names, dict, className, clsName</i>)
340 <p> 340 <p>
341 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#109;&#101;&#116;&#104;&#111;&#100;&#115; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#99;&#108;&#97;&#115;&#115;. 341 Private method to generate the methods list section of a class.
342 </p><dl> 342 </p><dl>
343 <dt><i>names</i></dt> 343 <dt><i>names</i></dt>
344 <dd> 344 <dd>
345 &#84;&#104;&#101; &#110;&#97;&#109;&#101;&#115; &#116;&#111; &#97;&#112;&#112;&#101;&#97;&#114; &#105;&#110; &#116;&#104;&#101; &#108;&#105;&#115;&#116;. (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 345 The names to appear in the list. (list of strings)
346 </dd><dt><i>dict</i></dt> 346 </dd><dt><i>dict</i></dt>
347 <dd> 347 <dd>
348 &#65; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#97;&#108;&#108; &#114;&#101;&#108;&#101;v&#97;&#110;&#116; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;. 348 A dictionary containing all relevant information.
349 </dd><dt><i>className</i></dt> 349 </dd><dt><i>className</i></dt>
350 <dd> 350 <dd>
351 &#84;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#110;&#97;&#109;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#110;&#97;&#109;&#101;&#115;. 351 The class name containing the names.
352 </dd><dt><i>clsName</i></dt> 352 </dd><dt><i>clsName</i></dt>
353 <dd> 353 <dd>
354 &#84;&#104;&#101; v&#105;&#115;&#105;&#98;&#108;&#101; &#99;&#108;&#97;&#115;&#115; &#110;&#97;&#109;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#110;&#97;&#109;&#101;&#115;. 354 The visible class name containing the names.
355 </dd> 355 </dd>
356 </dl><dl> 356 </dl><dl>
357 <dt>Returns:</dt> 357 <dt>Returns:</dt>
358 <dd> 358 <dd>
359 &#84;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 359 The list section. (string)
360 </dd> 360 </dd>
361 </dl><a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> 361 </dl><a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a>
362 <h4>ModuleDocument.__genModuleSection</h4> 362 <h4>ModuleDocument.__genModuleSection</h4>
363 <b>__genModuleSection</b>(<i></i>) 363 <b>__genModuleSection</b>(<i></i>)
364 <p> 364 <p>
365 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#98;&#111;&#100;y &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;. 365 Private method to generate the body of the document.
366 </p><dl> 366 </p><dl>
367 <dt>Returns:</dt> 367 <dt>Returns:</dt>
368 <dd> 368 <dd>
369 &#84;&#104;&#101; &#98;&#111;&#100;y &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;. (&#115;&#116;&#114;&#105;&#110;&#103;) 369 The body of the document. (string)
370 </dd> 370 </dd>
371 </dl><a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> 371 </dl><a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a>
372 <h4>ModuleDocument.__genParagraphs</h4> 372 <h4>ModuleDocument.__genParagraphs</h4>
373 <b>__genParagraphs</b>(<i>lines</i>) 373 <b>__genParagraphs</b>(<i>lines</i>)
374 <p> 374 <p>
375 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#115;&#115;&#101;&#109;&#98;&#108;&#101; &#116;&#104;&#101; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;v&#101; &#112;&#97;&#114;&#97;&#103;&#114;&#97;&#112;&#104;&#115; &#111;&#102; &#97; &#100;&#111;&#99;&#115;&#116;&#114;&#105;&#110;&#103;. 375 Private method to assemble the descriptive paragraphs of a docstring.
376 </p><p> 376 </p><p>
377 &#65; &#112;&#97;&#114;&#97;&#103;&#114;&#97;&#112;&#104; &#105;&#115; &#109;&#97;&#100;&#101; &#117;&#112; &#111;&#102; &#97; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#99;&#111;&#110;&#115;&#101;&#99;&#117;&#116;&#105;v&#101; &#108;&#105;&#110;&#101;&#115; w&#105;&#116;&#104;&#111;&#117;&#116; 377 A paragraph is made up of a number of consecutive lines without
378 &#97;&#110; &#105;&#110;&#116;&#101;&#114;&#109;&#101;&#100;&#105;&#97;&#116;&#101; &#101;&#109;&#112;&#116;y &#108;&#105;&#110;&#101;. &#69;&#109;&#112;&#116;y &#108;&#105;&#110;&#101;&#115; &#97;&#114;&#101; &#116;&#114;&#101;&#97;&#116;&#101;&#100; &#97;&#115; &#97; &#112;&#97;&#114;&#97;&#103;&#114;&#97;&#112;&#104; 378 an intermediate empty line. Empty lines are treated as a paragraph
379 &#100;&#101;&#108;&#105;&#109;&#105;&#116;&#101;&#114;. 379 delimiter.
380 </p><dl> 380 </p><dl>
381 <dt><i>lines</i></dt> 381 <dt><i>lines</i></dt>
382 <dd> 382 <dd>
383 &#65; &#108;&#105;&#115;&#116; &#111;&#102; &#105;&#110;&#100;&#105;v&#105;&#100;&#117;&#97;&#108; &#108;&#105;&#110;&#101;&#115;. (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 383 A list of individual lines. (list of strings)
384 </dd> 384 </dd>
385 </dl><dl> 385 </dl><dl>
386 <dt>Returns:</dt> 386 <dt>Returns:</dt>
387 <dd> 387 <dd>
388 &#82;&#101;&#97;&#100;y &#102;&#111;&#114;&#109;&#97;&#116;&#116;&#101;&#100; &#112;&#97;&#114;&#97;&#103;&#114;&#97;&#112;&#104;&#115;. (&#115;&#116;&#114;&#105;&#110;&#103;) 388 Ready formatted paragraphs. (string)
389 </dd> 389 </dd>
390 </dl><a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> 390 </dl><a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a>
391 <h4>ModuleDocument.__genParamDescriptionListSection</h4> 391 <h4>ModuleDocument.__genParamDescriptionListSection</h4>
392 <b>__genParamDescriptionListSection</b>(<i>_list, template</i>) 392 <b>__genParamDescriptionListSection</b>(<i>_list, template</i>)
393 <p> 393 <p>
394 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;. 394 Private method to generate the list section of a description.
395 </p><dl> 395 </p><dl>
396 <dt><i>_list</i></dt> 396 <dt><i>_list</i></dt>
397 <dd> 397 <dd>
398 &#76;&#105;&#115;&#116; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#102;&#111; &#102;&#111;&#114; &#116;&#104;&#101; 398 List containing the info for the
399 &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. 399 list section.
400 </dd><dt><i>template</i></dt> 400 </dd><dt><i>template</i></dt>
401 <dd> 401 <dd>
402 &#84;&#104;&#101; &#116;&#101;&#109;&#112;&#108;&#97;&#116;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#108;&#105;&#115;&#116;. (&#115;&#116;&#114;&#105;&#110;&#103;) 402 The template to be used for the list. (string)
403 </dd> 403 </dd>
404 </dl><dl> 404 </dl><dl>
405 <dt>Returns:</dt> 405 <dt>Returns:</dt>
406 <dd> 406 <dd>
407 &#84;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 407 The list section. (string)
408 </dd> 408 </dd>
409 </dl><a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> 409 </dl><a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a>
410 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> 410 <h4>ModuleDocument.__genRbModulesClassesListSection</h4>
411 <b>__genRbModulesClassesListSection</b>(<i>names, dict, moduleName</i>) 411 <b>__genRbModulesClassesListSection</b>(<i>names, dict, moduleName</i>)
412 <p> 412 <p>
413 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101;. 413 Private method to generate the classes list section of a Ruby module.
414 </p><dl> 414 </p><dl>
415 <dt><i>names</i></dt> 415 <dt><i>names</i></dt>
416 <dd> 416 <dd>
417 &#84;&#104;&#101; &#110;&#97;&#109;&#101;&#115; &#116;&#111; &#97;&#112;&#112;&#101;&#97;&#114; &#105;&#110; &#116;&#104;&#101; &#108;&#105;&#115;&#116;. (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 417 The names to appear in the list. (list of strings)
418 </dd><dt><i>dict</i></dt> 418 </dd><dt><i>dict</i></dt>
419 <dd> 419 <dd>
420 &#65; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#97;&#108;&#108; &#114;&#101;&#108;&#101;v&#97;&#110;&#116; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;. 420 A dictionary containing all relevant information.
421 </dd><dt><i>moduleName</i></dt> 421 </dd><dt><i>moduleName</i></dt>
422 <dd> 422 <dd>
423 &#78;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115;. (&#115;&#116;&#114;&#105;&#110;&#103;) 423 Name of the Ruby module containing the classes. (string)
424 </dd> 424 </dd>
425 </dl><dl> 425 </dl><dl>
426 <dt>Returns:</dt> 426 <dt>Returns:</dt>
427 <dd> 427 <dd>
428 &#84;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 428 The list section. (string)
429 </dd> 429 </dd>
430 </dl><a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> 430 </dl><a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a>
431 <h4>ModuleDocument.__genRbModulesClassesSection</h4> 431 <h4>ModuleDocument.__genRbModulesClassesSection</h4>
432 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>) 432 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>)
433 <p> 433 <p>
434 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. 434 Private method to generate the Ruby module classes details section.
435 </p><dl> 435 </p><dl>
436 <dt><i>obj</i></dt> 436 <dt><i>obj</i></dt>
437 <dd> 437 <dd>
438 &#82;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#111;&#98;&#106;&#101;&#99;&#116; &#98;&#101;&#105;&#110;&#103; &#102;&#111;&#114;&#109;&#97;&#116;&#116;&#101;&#100;. 438 Reference to the object being formatted.
439 </dd><dt><i>modName</i></dt> 439 </dd><dt><i>modName</i></dt>
440 <dd> 440 <dd>
441 &#78;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115;. (&#115;&#116;&#114;&#105;&#110;&#103;) 441 Name of the Ruby module containing the classes. (string)
442 </dd> 442 </dd>
443 </dl><dl> 443 </dl><dl>
444 <dt>Returns:</dt> 444 <dt>Returns:</dt>
445 <dd> 445 <dd>
446 &#84;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#108;&#105;&#115;&#116; &#97;&#110;&#100; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;w&#111; &#115;&#116;&#114;&#105;&#110;&#103;) 446 The classes list and classes details section. (tuple of two string)
447 </dd> 447 </dd>
448 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> 448 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a>
449 <h4>ModuleDocument.__genRbModulesListSection</h4> 449 <h4>ModuleDocument.__genRbModulesListSection</h4>
450 <b>__genRbModulesListSection</b>(<i></i>) 450 <b>__genRbModulesListSection</b>(<i></i>)
451 <p> 451 <p>
452 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#108;&#105;&#115;&#116;&#105;&#110;&#103; &#97;&#108;&#108; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; 452 Private method to generate the section listing all modules of the file
453 (&#82;&#117;&#98;y &#111;&#110;&#108;y). 453 (Ruby only).
454 </p><dl> 454 </p><dl>
455 <dt>Returns:</dt> 455 <dt>Returns:</dt>
456 <dd> 456 <dd>
457 &#84;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 457 The modules list section. (string)
458 </dd> 458 </dd>
459 </dl><a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> 459 </dl><a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a>
460 <h4>ModuleDocument.__genRbModulesSection</h4> 460 <h4>ModuleDocument.__genRbModulesSection</h4>
461 <b>__genRbModulesSection</b>(<i></i>) 461 <b>__genRbModulesSection</b>(<i></i>)
462 <p> 462 <p>
463 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; w&#105;&#116;&#104; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#97;&#98;&#111;&#117;&#116; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101;&#115;. 463 Private method to generate the document section with details about Ruby modules.
464 </p><dl> 464 </p><dl>
465 <dt>Returns:</dt> 465 <dt>Returns:</dt>
466 <dd> 466 <dd>
467 &#84;&#104;&#101; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#100;&#101;&#116;&#97;&#105;&#108;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 467 The Ruby modules details section. (string)
468 </dd> 468 </dd>
469 </dl><a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> 469 </dl><a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a>
470 <h4>ModuleDocument.__genSeeListSection</h4> 470 <h4>ModuleDocument.__genSeeListSection</h4>
471 <b>__genSeeListSection</b>(<i>_list, template</i>) 471 <b>__genSeeListSection</b>(<i>_list, template</i>)
472 <p> 472 <p>
473 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; "&#115;&#101;&#101; &#97;&#108;&#115;&#111;" &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;. 473 Private method to generate the "see also" list section of a description.
474 </p><dl> 474 </p><dl>
475 <dt><i>_list</i></dt> 475 <dt><i>_list</i></dt>
476 <dd> 476 <dd>
477 &#76;&#105;&#115;&#116; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#102;&#111; &#102;&#111;&#114; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. 477 List containing the info for the section.
478 </dd><dt><i>template</i></dt> 478 </dd><dt><i>template</i></dt>
479 <dd> 479 <dd>
480 &#84;&#104;&#101; &#116;&#101;&#109;&#112;&#108;&#97;&#116;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#108;&#105;&#115;&#116;. (&#115;&#116;&#114;&#105;&#110;&#103;) 480 The template to be used for the list. (string)
481 </dd> 481 </dd>
482 </dl><dl> 482 </dl><dl>
483 <dt>Returns:</dt> 483 <dt>Returns:</dt>
484 <dd> 484 <dd>
485 &#84;&#104;&#101; &#108;&#105;&#115;&#116; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 485 The list section. (string)
486 </dd> 486 </dd>
487 </dl><a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> 487 </dl><a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a>
488 <h4>ModuleDocument.__getShortDescription</h4> 488 <h4>ModuleDocument.__getShortDescription</h4>
489 <b>__getShortDescription</b>(<i>desc</i>) 489 <b>__getShortDescription</b>(<i>desc</i>)
490 <p> 490 <p>
491 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#101; &#116;&#104;&#101; &#115;&#104;&#111;&#114;&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#111;&#102; &#97;&#110; &#111;&#98;&#106;&#101;&#99;&#116;. 491 Private method to determine the short description of an object.
492 </p><p> 492 </p><p>
493 &#84;&#104;&#101; &#115;&#104;&#111;&#114;&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#105;&#115; &#106;&#117;&#115;&#116; &#116;&#104;&#101; &#102;&#105;&#114;&#115;&#116; &#110;&#111;&#110; &#101;&#109;&#112;&#116;y &#108;&#105;&#110;&#101; &#111;&#102; &#116;&#104;&#101; 493 The short description is just the first non empty line of the
494 &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103;. 494 documentation string.
495 </p><dl> 495 </p><dl>
496 <dt><i>desc</i></dt> 496 <dt><i>desc</i></dt>
497 <dd> 497 <dd>
498 &#84;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103;. (&#115;&#116;&#114;&#105;&#110;&#103;) 498 The documentation string. (string)
499 </dd> 499 </dd>
500 </dl><dl> 500 </dl><dl>
501 <dt>Returns:</dt> 501 <dt>Returns:</dt>
502 <dd> 502 <dd>
503 &#84;&#104;&#101; &#115;&#104;&#111;&#114;&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 503 The short description. (string)
504 </dd> 504 </dd>
505 </dl><a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> 505 </dl><a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a>
506 <h4>ModuleDocument.__processInlineTags</h4> 506 <h4>ModuleDocument.__processInlineTags</h4>
507 <b>__processInlineTags</b>(<i>desc</i>) 507 <b>__processInlineTags</b>(<i>desc</i>)
508 <p> 508 <p>
509 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#105;&#110;&#108;&#105;&#110;&#101; &#116;&#97;&#103;&#115;. 509 Private method to process inline tags.
510 </p><dl> 510 </p><dl>
511 <dt><i>desc</i></dt> 511 <dt><i>desc</i></dt>
512 <dd> 512 <dd>
513 &#79;&#110;&#101; &#108;&#105;&#110;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;) 513 One line of the description (string)
514 </dd> 514 </dd>
515 </dl><dl> 515 </dl><dl>
516 <dt>Returns:</dt> 516 <dt>Returns:</dt>
517 <dd> 517 <dd>
518 &#112;&#114;&#111;&#99;&#101;&#115;&#115;&#101;&#100; &#108;&#105;&#110;&#101; w&#105;&#116;&#104; &#105;&#110;&#108;&#105;&#110;&#101; &#116;&#97;&#103;&#115; &#101;x&#112;&#97;&#110;&#100;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;) 518 processed line with inline tags expanded (string)
519 </dd> 519 </dd>
520 </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a> 520 </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a>
521 <h4>ModuleDocument.description</h4> 521 <h4>ModuleDocument.description</h4>
522 <b>description</b>(<i></i>) 522 <b>description</b>(<i></i>)
523 <p> 523 <p>
524 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;. 524 Public method used to get the description of the module.
525 </p><dl> 525 </p><dl>
526 <dt>Returns:</dt> 526 <dt>Returns:</dt>
527 <dd> 527 <dd>
528 &#84;&#104;&#101; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;. (&#115;&#116;&#114;&#105;&#110;&#103;) 528 The description of the module. (string)
529 </dd> 529 </dd>
530 </dl><a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> 530 </dl><a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a>
531 <h4>ModuleDocument.genDocument</h4> 531 <h4>ModuleDocument.genDocument</h4>
532 <b>genDocument</b>(<i></i>) 532 <b>genDocument</b>(<i></i>)
533 <p> 533 <p>
534 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;. 534 Public method to generate the source code documentation.
535 </p><dl> 535 </p><dl>
536 <dt>Returns:</dt> 536 <dt>Returns:</dt>
537 <dd> 537 <dd>
538 &#84;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;) 538 The source code documentation. (string)
539 </dd> 539 </dd>
540 </dl><a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> 540 </dl><a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a>
541 <h4>ModuleDocument.getQtHelpKeywords</h4> 541 <h4>ModuleDocument.getQtHelpKeywords</h4>
542 <b>getQtHelpKeywords</b>(<i></i>) 542 <b>getQtHelpKeywords</b>(<i></i>)
543 <p> 543 <p>
544 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#112;&#97;&#114;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#107;&#101;yw&#111;&#114;&#100;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;. 544 Public method to retrieve the parts for the QtHelp keywords section.
545 </p><dl> 545 </p><dl>
546 <dt>Returns:</dt> 546 <dt>Returns:</dt>
547 <dd> 547 <dd>
548 &#108;&#105;&#115;&#116; &#111;&#102; &#116;&#117;&#112;&#108;&#101;&#115; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) &#97;&#110;&#100; &#116;&#104;&#101; &#114;&#101;&#102; (&#115;&#116;&#114;&#105;&#110;&#103;). &#84;&#104;&#101; &#114;&#101;&#102; 548 list of tuples containing the name (string) and the ref (string). The ref
549 &#105;&#115; w&#105;&#116;&#104;&#111;&#117;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#112;&#97;&#114;&#116;. 549 is without the filename part.
550 </dd> 550 </dd>
551 </dl><a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> 551 </dl><a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a>
552 <h4>ModuleDocument.isEmpty</h4> 552 <h4>ModuleDocument.isEmpty</h4>
553 <b>isEmpty</b>(<i></i>) 553 <b>isEmpty</b>(<i></i>)
554 <p> 554 <p>
555 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#101;, &#105;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#115; &#97;&#110;y &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#111;&#114; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;. 555 Public method to determine, if the module contains any classes or functions.
556 </p><dl> 556 </p><dl>
557 <dt>Returns:</dt> 557 <dt>Returns:</dt>
558 <dd> 558 <dd>
559 &#70;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97;&#110; &#101;&#109;&#112;&#116;y &#109;&#111;&#100;&#117;&#108;&#101; (&#105;.&#101;. &#95;&#95;&#105;&#110;&#105;&#116;&#95;&#95;.&#112;y w&#105;&#116;&#104;&#111;&#117;&#116; 559 Flag indicating an empty module (i.e. __init__.py without
560 &#97;&#110;y &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115;) 560 any contents)
561 </dd> 561 </dd>
562 </dl><a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a> 562 </dl><a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a>
563 <h4>ModuleDocument.name</h4> 563 <h4>ModuleDocument.name</h4>
564 <b>name</b>(<i></i>) 564 <b>name</b>(<i></i>)
565 <p> 565 <p>
566 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#110;&#97;&#109;&#101;. 566 Public method used to get the module name.
567 </p><dl> 567 </p><dl>
568 <dt>Returns:</dt> 568 <dt>Returns:</dt>
569 <dd> 569 <dd>
570 &#84;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;. (&#115;&#116;&#114;&#105;&#110;&#103;) 570 The name of the module. (string)
571 </dd> 571 </dd>
572 </dl><a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> 572 </dl><a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a>
573 <h4>ModuleDocument.shortDescription</h4> 573 <h4>ModuleDocument.shortDescription</h4>
574 <b>shortDescription</b>(<i></i>) 574 <b>shortDescription</b>(<i></i>)
575 <p> 575 <p>
576 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#115;&#104;&#111;&#114;&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;. 576 Public method used to get the short description of the module.
577 </p><p> 577 </p><p>
578 &#84;&#104;&#101; &#115;&#104;&#111;&#114;&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#105;&#115; &#106;&#117;&#115;&#116; &#116;&#104;&#101; &#102;&#105;&#114;&#115;&#116; &#108;&#105;&#110;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;&#115; 578 The short description is just the first line of the modules
579 &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;. 579 description.
580 </p><dl> 580 </p><dl>
581 <dt>Returns:</dt> 581 <dt>Returns:</dt>
582 <dd> 582 <dd>
583 &#84;&#104;&#101; &#115;&#104;&#111;&#114;&#116; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;. (&#115;&#116;&#114;&#105;&#110;&#103;) 583 The short description of the module. (string)
584 </dd> 584 </dd>
585 </dl> 585 </dl>
586 <div align="right"><a href="#top">Up</a></div> 586 <div align="right"><a href="#top">Up</a></div>
587 <hr /><hr /> 587 <hr /><hr />
588 <a NAME="TagError" ID="TagError"></a> 588 <a NAME="TagError" ID="TagError"></a>
589 <h2>TagError</h2> 589 <h2>TagError</h2>
590 <p> 590 <p>
591 &#69;x&#99;&#101;&#112;&#116;&#105;&#111;&#110; &#99;&#108;&#97;&#115;&#115; &#114;&#97;&#105;&#115;&#101;&#100;, &#105;&#102; &#97;&#110; &#105;&#110;v&#97;&#108;&#105;&#100; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#116;&#97;&#103; w&#97;&#115; &#102;&#111;&#117;&#110;&#100;. 591 Exception class raised, if an invalid documentation tag was found.
592 </p> 592 </p>
593 <h3>Derived from</h3> 593 <h3>Derived from</h3>
594 Exception 594 Exception
595 <h3>Class Attributes</h3> 595 <h3>Class Attributes</h3>
596 <table> 596 <table>

Mercurial Repository: eric

eric ide

mercurial