1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>Class: MStructDocSet</title>
</head>
<body bgcolor="#ffffff">
<p><i><a href="../../../index.html">Table of Contents</a></i></p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#88bbee">
<th rowspan="2"
valign="top"
align="left"
width="10%"><font color="#000000">Class: MStructDocSet</font>
</th>
<th width="90%" align="right"><font color="#000000">../HappyDoc-r2_0/happydoclib/docset/docset_mstruct.py</font></th>
</tr>
<tr>
<td>
<h3>Documentation set written to multiple structured files.</h3>
<h4> Parameters</h4>
<p> <em>Adds no additional parameters not understood by DocSet.</em></p>
<p> Do not use multiple lines in the class docstring, since it shows up as
part of the generated help message for the app and multiple lines throws
off the formatting.</p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Base Classes">Base Classes</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
happydoclib.happydocset.DocSet<br>
</td></tr>
</table>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Methods">Methods</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<table border="0" cellspacing="2" cellpadding="2" width="100%">
<tr>
<td align="LEFT" valign="TOP">
<a href="#__init__">__init__</a><br>
<a href="#_writeBaseClassNames">_writeBaseClassNames</a><br>
<a href="#_writeClass">_writeClass</a><br>
<a href="#_writeFunction">_writeFunction</a><br>
<a href="#_writeModule">_writeModule</a><br>
</td>
<td align="LEFT" valign="TOP">
<a href="#_writeModules">_writeModules</a><br>
<a href="#_writePackages">_writePackages</a><br>
<a href="#closeOutput">closeOutput</a><br>
<a href="#openOutput">openOutput</a><br>
<a href="#write">write</a><br>
</td>
</tr>
</table>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="__init__"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">__init__ </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
__init__ ( self, **args )
</pre></font>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="_writeBaseClassNames"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">_writeBaseClassNames </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
_writeBaseClassNames (
self,
parent,
cinfo,
output,
indent=0,
)
</pre></font>
<h3>Output the base class hierarchy for the given class.</h3>
<h4> Arguments</h4>
<dl>
<dt> <code>parent</code></dt>
<dd>info about class parent (module, class)</dd>
<dt> <code>cinfo</code></dt>
<dd>class info</dd>
<dt> <code>output</code></dt>
<dd>current output file object</dd>
</dl>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="_writeClass"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">_writeClass </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
_writeClass (
self,
parent,
class_name,
output,
)
</pre></font>
<h3>Output the documentation for the class in the parent object.</h3>
<h4> Arguments</h4>
<dl>
<dt> <code>parent</code></dt>
<dd>info about class parent (module, class)</dd>
<dt> <code>class_name</code></dt>
<dd>name of the class</dd>
<dt> <code>output</code></dt>
<dd>current output file object</dd>
</dl>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="_writeFunction"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">_writeFunction </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
_writeFunction (
self,
function_name,
getInfo,
output,
)
</pre></font>
<h3>Output the documentation for the function in the parent object.</h3>
<h4> Arguments</h4>
<dl>
<dt> <code>function_name</code></dt>
<dd>the function name</dd>
<dt> <code>getInfo</code></dt>
<dd>reference to method, which will return function info</dd>
<dt> <code>output</code></dt>
<dd>current output file object</dd>
</dl>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="_writeModule"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">_writeModule </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
_writeModule ( self, module_name )
</pre></font>
<h3>Output the documentation for the named module.</h3>
<h4> Arguments</h4>
<dl>
<dt> <code>module_name</code></dt>
<dd>name of the module</dd>
</dl>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="_writeModules"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">_writeModules </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
_writeModules ( self )
</pre></font>
<p>Output documentation for all modules.</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="_writePackages"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">_writePackages </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
_writePackages ( self )
</pre></font>
<p>Output documentation for all packages.</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="closeOutput"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">closeOutput </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
closeOutput (
self,
output,
rtype=INDEX_FILE,
)
</pre></font>
<h3>Closes output, where documentation has been written.</h3>
<h4> Arguments</h4>
<dl>
<dt> <code>output</code></dt>
<dd>file object of opened documentation file</dd>
<dt> <code>rtype</code></dt>
<dd>gives info whether index, module or class file will be closed</dd>
</dl>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="openOutput"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">openOutput </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
openOutput (
self,
name,
title,
subtitle,
rtype=INDEX_FILE,
)
</pre></font>
<h3>Opens output, where documentation will be written.</h3>
<h4> Arguments</h4>
<dl>
<dt> <code>name</code></dt>
<dd>output file name</dd>
<dt> <code>title</code></dt>
<dd>title of documentation file</dd>
<dt> <code>subtitle</code></dt>
<dd>subtitle of documentation file</dd>
<dt> <code>rtype</code></dt>
<dd>gives info whether index, module or class file will be opened</dd>
</dl>
<p> Returns file object of opened documentation file.</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="write"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">write </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
write ( self )
</pre></font>
<p>Write the documentation set to the output.</p>
</td></tr>
</td></tr>
</table>
</td>
</tr>
</table>
<hr>
<p><i><a href="../../../index.html">Table of Contents</a></i></p>
<font size="-2"><i>This document was automatically generated
on Sun Dec 30 07:30:05 2001 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.0</i></font>
</body>
</html>
|
