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