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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.markup.ParsedDocstring</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
Class ParsedDocstring
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.markup.ParsedDocstring-class.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.markup.ParsedDocstring-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class ParsedDocstring</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html"><code>ParsedEpytextDocstring</code></a>,
<a href="epydoc.markup.javadoc.ParsedJavadocDocstring-class.html"><code>ParsedJavadocDocstring</code></a>,
<a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html"><code>ParsedPlaintextDocstring</code></a>,
<a href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html"><code>ParsedRstDocstring</code></a></dd></dl>
<hr/>
A standard intermediate representation for parsed docstrings that can
be used to generate output. Parsed docstrings are produced by markup
parsers (such as <a href="epydoc.markup.epytext-module.html#parse"
class="link"><code>epytext.parse</code></a> or <a
href="epydoc.markup-module.html#parse"
class="link"><code>javadoc.parse</code></a>).
<code>ParsedDocstring</code>s support several kinds of operation:
<ul>
<li>
output generation (<a
href="epydoc.markup.ParsedDocstring-class.html#to_plaintext"
class="link"><code>to_plaintext()</code></a>, <a
href="epydoc.markup.ParsedDocstring-class.html#to_html"
class="link"><code>to_html()</code></a>, and <a
href="epydoc.markup.ParsedDocstring-class.html#to_latex"
class="link"><code>to_latex()</code></a>).
</li>
<li>
Summarization (<a
href="epydoc.markup.ParsedDocstring-class.html#summary"
class="link"><code>summary()</code></a>).
</li>
<li>
Field extraction (<a
href="epydoc.markup.ParsedDocstring-class.html#split_fields"
class="link"><code>split_fields()</code></a>).
</li>
<li>
Index term extraction (<a
href="epydoc.markup.ParsedDocstring-class.html#index_terms"
class="link"><code>index_terms()</code></a>.
</li>
</ul>
The output generation methods (<code>to_<i
class="math">format</i>()</code>) use a <a
href="epydoc.markup.DocstringLinker-class.html"
class="link"><code>DocstringLinker</code></a> to link the docstring
output with the rest of the documentation that epydoc generates.
<h1 class="heading">Subclassing</h1>
The only method that a subclass is <i>required</i> to implement is
<a href="epydoc.markup.ParsedDocstring-class.html#to_plaintext"
class="link"><code>to_plaintext()</code></a>; but it is often useful to
override the other methods. The default behavior of each method is
described below:
<ul>
<li>
<code>to_<i>format</i></code>: Calls <code>to_plaintext</code>,
and uses the string it returns to generate verbatim output.
</li>
<li>
<code>summary</code>: Returns <code>self</code> (i.e., the
entire docstring).
</li>
<li>
<code>split_fields</code>: Returns <code>(self, [])</code>
(i.e., extracts no fields).
</li>
<li>
<code>index_terms</code>: Returns <code>[]</code> (i.e.,
extracts no index terms).
</li>
</ul>
If and when epydoc adds more output formats, new
<code>to_<i>format</i></code> methods will be added to this base class;
but they will always be given a default implementation.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__add__"></a><span class="summary-sig"><span class="summary-sig-name">__add__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.ParsedDocstring-class.html#concatenate" class="summary-sig-name"><code>concatenate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Return a new parsed docstring containing the concatination of this docstring
and <code>other</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <code>ParsedDocstring</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.ParsedDocstring-class.html#index_terms" class="summary-sig-name"><code>index_terms</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the list of index terms that are defined in this docstring.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>(<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>, list of <a
href="epydoc.markup.Field-class.html"
class="link"><code>Field</code></a>)</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.ParsedDocstring-class.html#split_fields" class="summary-sig-name"><code>split_fields</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Split this docstring into its body and its fields.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.ParsedDocstring-class.html#summary" class="summary-sig-name"><code>summary</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a short summary of this docstring.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.ParsedDocstring-class.html#to_html" class="summary-sig-name"><code>to_html</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>docstring_linker</span>,
<span class="summary-sig-kwarg">**options</span>)</span></code>
<br />
Translate this docstring to HTML.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.ParsedDocstring-class.html#to_latex" class="summary-sig-name"><code>to_latex</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>docstring_linker</span>,
<span class="summary-sig-kwarg">**options</span>)</span></code>
<br />
Translate this docstring to LaTeX.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.ParsedDocstring-class.html#to_plaintext" class="summary-sig-name"><code>to_plaintext</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>docstring_linker</span>,
<span class="summary-sig-kwarg">**options</span>)</span></code>
<br />
Translate this docstring to plaintext.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="concatenate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">concatenate</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A new parsed docstring containing the concatination of this
docstring and <code>other</code>.
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ValueError</b></code> -
If the two parsed docstrings are incompatible.
</dl>
</dd></dl>
</td></tr></table>
<a name="index_terms"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">index_terms</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The list of index terms that are defined in this docstring.
Each of these items will be added to the index page of the
documentation.
<br /><i>
(type=<code>list</code> of <code>ParsedDocstring</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="split_fields"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">split_fields</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>errors</span>=<span class=sig-default>None</span>)</span>
</h3>
Split this docstring into its body and its fields.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>errors</b></code> -
A list where any errors generated during splitting will be
stored. If no list is specified, then errors will be ignored.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A tuple <code>(<i class="math">body</i>, <i
class="math">fields</i>)</code>, where <code><i
class="math">body</i></code> is the main body of this docstring,
and <code><i class="math">fields</i></code> is a list of its
fields.
<br /><i>
(type=<code>(<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>, list of <a
href="epydoc.markup.Field-class.html"
class="link"><code>Field</code></a>)</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="summary"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">summary</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A short summary of this docstring. Typically, the summary
consists of the first sentence of the docstring.
<br /><i>
(type=<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="to_html"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_html</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>docstring_linker</span>,
<span class="sig-kwarg">**options</span>)</span>
</h3>
Translate this docstring to HTML.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>docstring_linker</b></code> -
An HTML translator for crossreference links into and out of
the docstring.
<br /><i>
(type=<a href="epydoc.markup.DocstringLinker-class.html"
class="link"><code>DocstringLinker</code></a>)</i>
<dd><code><b>options</b></code> -
Any extra options for the output. Unknown options are
ignored.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
An HTML fragment that encodes this docstring.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="to_latex"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_latex</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>docstring_linker</span>,
<span class="sig-kwarg">**options</span>)</span>
</h3>
Translate this docstring to LaTeX.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>docstring_linker</b></code> -
A LaTeX translator for crossreference links into and out of
the docstring.
<br /><i>
(type=<a href="epydoc.markup.DocstringLinker-class.html"
class="link"><code>DocstringLinker</code></a>)</i>
<dd><code><b>options</b></code> -
Any extra options for the output. Unknown options are
ignored.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A LaTeX fragment that encodes this docstring.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="to_plaintext"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_plaintext</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>docstring_linker</span>,
<span class="sig-kwarg">**options</span>)</span>
</h3>
Translate this docstring to plaintext.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>docstring_linker</b></code> -
A plaintext translator for crossreference links into and out
of the docstring.
<br /><i>
(type=<a href="epydoc.markup.DocstringLinker-class.html"
class="link"><code>DocstringLinker</code></a>)</i>
<dd><code><b>options</b></code> -
Any extra options for the output. Unknown options are
ignored.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A plaintext fragment that encodes this docstring.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
