1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>epydoc.markup.epytext.ParsedEpytextDocstring</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="epydoc-module.html">Package epydoc</a> ::
33
<a href="epydoc.markup-module.html">Package markup</a> ::
34
<a href="epydoc.markup.epytext-module.html">Module epytext</a> ::
35
Class ParsedEpytextDocstring
38
<td><table cellpadding="0" cellspacing="0">
39
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.markup.epytext.ParsedEpytextDocstring-class.html">show private</a> | hide private]</font></td></tr>
40
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html" target="_top">no frames</a>]</font></td></tr>
44
<!-- =========== START OF CLASS DESCRIPTION =========== -->
45
<h2 class="class">Class ParsedEpytextDocstring</h2>
47
<pre class="base-tree">
48
<a href="epydoc.markup.ParsedDocstring-class.html"><code>ParsedDocstring</code></a> --+
50
<b>ParsedEpytextDocstring</b>
56
<!-- =========== START OF METHOD SUMMARY =========== -->
57
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
58
<tr bgcolor="#70b0f0" class="summary">
59
<th colspan="2">Method Summary</th></tr>
60
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
61
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
62
<span class=summary-sig-arg>dom_tree</span>)</span></code>
64
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
65
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#concatenate" class="summary-sig-name"><code>concatenate</code></a>(<span class=summary-sig-arg>self</span>,
66
<span class=summary-sig-arg>other</span>)</span></code>
68
Return a new parsed docstring containing the concatination of this docstring
69
and <code>other</code>.</td></tr>
70
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <code>ParsedDocstring</code>
72
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#index_terms" class="summary-sig-name"><code>index_terms</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
74
Return the list of index terms that are defined in this docstring.</td></tr>
75
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>(<a href="epydoc.markup.ParsedDocstring-class.html"
76
class="link"><code>ParsedDocstring</code></a>, list of <a
77
href="epydoc.markup.Field-class.html"
78
class="link"><code>Field</code></a>)</code>
80
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#split_fields" class="summary-sig-name"><code>split_fields</code></a>(<span class=summary-sig-arg>self</span>,
81
<span class=summary-sig-arg>errors</span>)</span></code>
83
Split this docstring into its body and its fields.</td></tr>
84
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.markup.ParsedDocstring-class.html"
85
class="link"><code>ParsedDocstring</code></a>
87
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#summary" class="summary-sig-name"><code>summary</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
89
Return a short summary of this docstring.</td></tr>
90
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
92
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html" class="summary-sig-name"><code>to_html</code></a>(<span class=summary-sig-arg>self</span>,
93
<span class=summary-sig-arg>docstring_linker</span>,
94
<span class="summary-sig-kwarg">**options</span>)</span></code>
96
Translate this docstring to HTML.</td></tr>
97
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
99
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_latex" class="summary-sig-name"><code>to_latex</code></a>(<span class=summary-sig-arg>self</span>,
100
<span class=summary-sig-arg>docstring_linker</span>,
101
<span class="summary-sig-kwarg">**options</span>)</span></code>
103
Translate this docstring to LaTeX.</td></tr>
104
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
106
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext" class="summary-sig-name"><code>to_plaintext</code></a>(<span class=summary-sig-arg>self</span>,
107
<span class=summary-sig-arg>docstring_linker</span>,
108
<span class="summary-sig-kwarg">**options</span>)</span></code>
110
Translate this docstring to plaintext.</td></tr>
112
<b>Inherited from <a href="epydoc.markup.ParsedDocstring-class.html"><code>ParsedDocstring</code></a>:</b>
113
<a href="epydoc.markup.ParsedDocstring-class.html#__add__"><code>__add__</code></a>
118
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
119
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
120
<tr bgcolor="#70b0f0" class="summary">
121
<th colspan="2">Class Variable Summary</th></tr>
122
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
123
<td><b><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#SYMBOL_TO_HTML"><code>SYMBOL_TO_HTML</code></a></b> = <span title="{'xi': 'xi', '>=': 'ge', 'lArr': 'lArr', 'Chi': 'Chi', 'omega': 'omega', 'ge': 'ge', 'sube': 'sube', 'asymp': 'asymp', 'otimes': 'otimes', 'zeta': 'zeta', 'prop': 'prop', 'Nu': 'Nu', 'equiv': 'equiv', 'Psi': 'Psi', 'integral': 'int', 'cup': 'cup', 'chi': 'chi', 'Eta': 'Eta', 'Beta': 'Beta', 'perp': 'perp', 'Delta': 'Delta', 'there4': 'there4', 'Upsilon': 'Upsilon', 'Lambda': 'Lambda', 'iota': 'iota', 'empty': 'empty', 'notin': 'notin', 'Kappa': 'Kappa', 'darr': 'darr', 'sup': 'sup', 'part': 'part', 'delta': 'delta', 'upsilon': 'upsilon', 'copy': 'copy', '^': 'uarr', 'Tau': 'Tau', 'Xi': 'Xi'..."><code>{'xi': 'xi', '>=': 'ge', 'lArr': 'lArr'<span class="variable-ellipsis">...</span></code>
125
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
126
<td><b><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#SYMBOL_TO_LATEX"><code>SYMBOL_TO_LATEX</code></a></b> = <span title="{'xi': '\\(\\xi\\)', '>=': '\\(\\ge\\)', 'lArr': '\\(\\Leftarrow\\)', 'Chi': '\\(\\chi\\)', 'omega': '\\(\\omega\\)', 'ge': '\\(\\ge\\)', 'sube': '\\(\\subseteq\\)', 'asymp': '\\(\\approx\\)', 'otimes': '\\(\\otimes\\)', 'zeta': '\\(\\zeta\\)', 'prop': '\\(\\propto\\)', 'Nu': '\\(\\nu\\)', 'equiv': '\\(\\equiv\\)', 'Psi': '\\(\\Psi\\)', 'integral': '\\(\\int\\)', 'cup': '\\(\\cup\\)', 'chi': '\\(\\chi\\)', 'Eta': '\\(\\eta\\)', 'Beta': '\\(\\beta\\)', 'perp': '\\(\\perp\\)', 'Delta': '\\(\\Delta\\)', 'there4': '\\(\\therefore\\)', 'Upsilon': '\\(\\Upsilon\\)', 'Lambda': '\\(\\Lambda\\)', 'i..."><code>{'xi': '\\(\\xi\\)', '>=': '\\(\\ge\\)<span class="variable-ellipsis">...</span></code>
131
<!-- =========== START OF METHOD DETAILS =========== -->
132
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
133
<tr bgcolor="#70b0f0" class="details">
134
<th colspan="2">Method Details</th></tr>
137
<a name="concatenate"></a>
138
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
139
<h3><span class="sig"><span class="sig-name">concatenate</span>(<span class=sig-arg>self</span>,
140
<span class=sig-arg>other</span>)</span>
143
<dl><dt><b>Returns:</b></dt>
145
A new parsed docstring containing the concatination of this
146
docstring and <code>other</code>.
149
<dl><dt><b>Raises:</b></dt>
150
<dd><code><b>ValueError</b></code> -
151
If the two parsed docstrings are incompatible.
153
<dl><dt><b>Overrides:</b></dt>
154
<dd><a href="epydoc.markup.ParsedDocstring-class.html#concatenate"><code>epydoc.markup.ParsedDocstring.concatenate</code></a> <i>(inherited documentation)</i>
160
<a name="index_terms"></a>
161
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
162
<h3><span class="sig"><span class="sig-name">index_terms</span>(<span class=sig-arg>self</span>)</span>
165
<dl><dt><b>Returns:</b></dt>
167
The list of index terms that are defined in this docstring.
168
Each of these items will be added to the index page of the
170
<br /><i>
171
(type=<code>list</code> of <code>ParsedDocstring</code>)</i>
174
<dl><dt><b>Overrides:</b></dt>
175
<dd><a href="epydoc.markup.ParsedDocstring-class.html#index_terms"><code>epydoc.markup.ParsedDocstring.index_terms</code></a> <i>(inherited documentation)</i>
181
<a name="split_fields"></a>
182
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
183
<h3><span class="sig"><span class="sig-name">split_fields</span>(<span class=sig-arg>self</span>,
184
<span class=sig-arg>errors</span>=<span class=sig-default>None</span>)</span>
186
Split this docstring into its body and its fields.
188
<dl><dt><b>Parameters:</b></dt>
189
<dd><code><b>errors</b></code> -
190
A list where any errors generated during splitting will be
191
stored. If no list is specified, then errors will be ignored.
192
<br /><i>
193
(type=<code>list</code> of <a
194
href="epydoc.markup.ParseError-class.html"
195
class="link"><code>ParseError</code></a>)</i>
198
<dl><dt><b>Returns:</b></dt>
200
A tuple <code>(<i class="math">body</i>, <i
201
class="math">fields</i>)</code>, where <code><i
202
class="math">body</i></code> is the main body of this docstring,
203
and <code><i class="math">fields</i></code> is a list of its
205
<br /><i>
206
(type=<code>(<a href="epydoc.markup.ParsedDocstring-class.html"
207
class="link"><code>ParsedDocstring</code></a>, list of <a
208
href="epydoc.markup.Field-class.html"
209
class="link"><code>Field</code></a>)</code>)</i>
212
<dl><dt><b>Overrides:</b></dt>
213
<dd><a href="epydoc.markup.ParsedDocstring-class.html#split_fields"><code>epydoc.markup.ParsedDocstring.split_fields</code></a> <i>(inherited documentation)</i>
219
<a name="summary"></a>
220
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
221
<h3><span class="sig"><span class="sig-name">summary</span>(<span class=sig-arg>self</span>)</span>
224
<dl><dt><b>Returns:</b></dt>
226
A short summary of this docstring. Typically, the summary
227
consists of the first sentence of the docstring.
228
<br /><i>
229
(type=<a href="epydoc.markup.ParsedDocstring-class.html"
230
class="link"><code>ParsedDocstring</code></a>)</i>
233
<dl><dt><b>Overrides:</b></dt>
234
<dd><a href="epydoc.markup.ParsedDocstring-class.html#summary"><code>epydoc.markup.ParsedDocstring.summary</code></a> <i>(inherited documentation)</i>
240
<a name="to_html"></a>
241
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
242
<h3><span class="sig"><span class="sig-name">to_html</span>(<span class=sig-arg>self</span>,
243
<span class=sig-arg>docstring_linker</span>,
244
<span class="sig-kwarg">**options</span>)</span>
246
Translate this docstring to HTML.
248
<dl><dt><b>Parameters:</b></dt>
249
<dd><code><b>docstring_linker</b></code> -
250
An HTML translator for crossreference links into and out of
252
<br /><i>
253
(type=<a href="epydoc.markup.DocstringLinker-class.html"
254
class="link"><code>DocstringLinker</code></a>)</i>
255
<dd><code><b>options</b></code> -
256
Any extra options for the output. Unknown options are
260
<dl><dt><b>Returns:</b></dt>
262
An HTML fragment that encodes this docstring.
263
<br /><i>
264
(type=<code>string</code>)</i>
267
<dl><dt><b>Overrides:</b></dt>
268
<dd><a href="epydoc.markup.ParsedDocstring-class.html#to_html"><code>epydoc.markup.ParsedDocstring.to_html</code></a> <i>(inherited documentation)</i>
274
<a name="to_latex"></a>
275
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
276
<h3><span class="sig"><span class="sig-name">to_latex</span>(<span class=sig-arg>self</span>,
277
<span class=sig-arg>docstring_linker</span>,
278
<span class="sig-kwarg">**options</span>)</span>
280
Translate this docstring to LaTeX.
282
<dl><dt><b>Parameters:</b></dt>
283
<dd><code><b>docstring_linker</b></code> -
284
A LaTeX translator for crossreference links into and out of
286
<br /><i>
287
(type=<a href="epydoc.markup.DocstringLinker-class.html"
288
class="link"><code>DocstringLinker</code></a>)</i>
289
<dd><code><b>options</b></code> -
290
Any extra options for the output. Unknown options are
294
<dl><dt><b>Returns:</b></dt>
296
A LaTeX fragment that encodes this docstring.
297
<br /><i>
298
(type=<code>string</code>)</i>
301
<dl><dt><b>Overrides:</b></dt>
302
<dd><a href="epydoc.markup.ParsedDocstring-class.html#to_latex"><code>epydoc.markup.ParsedDocstring.to_latex</code></a> <i>(inherited documentation)</i>
308
<a name="to_plaintext"></a>
309
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
310
<h3><span class="sig"><span class="sig-name">to_plaintext</span>(<span class=sig-arg>self</span>,
311
<span class=sig-arg>docstring_linker</span>,
312
<span class="sig-kwarg">**options</span>)</span>
314
Translate this docstring to plaintext.
316
<dl><dt><b>Parameters:</b></dt>
317
<dd><code><b>docstring_linker</b></code> -
318
A plaintext translator for crossreference links into and out
320
<br /><i>
321
(type=<a href="epydoc.markup.DocstringLinker-class.html"
322
class="link"><code>DocstringLinker</code></a>)</i>
323
<dd><code><b>options</b></code> -
324
Any extra options for the output. Unknown options are
328
<dl><dt><b>Returns:</b></dt>
330
A plaintext fragment that encodes this docstring.
331
<br /><i>
332
(type=<code>string</code>)</i>
335
<dl><dt><b>Overrides:</b></dt>
336
<dd><a href="epydoc.markup.ParsedDocstring-class.html#to_plaintext"><code>epydoc.markup.ParsedDocstring.to_plaintext</code></a> <i>(inherited documentation)</i>
344
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
345
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
346
<tr bgcolor="#70b0f0" class="details">
347
<th colspan="2">Class Variable Details</th></tr>
349
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
350
<a name="SYMBOL_TO_HTML"></a>
351
<h3>SYMBOL_TO_HTML</h3>
356
<dt><b>Type:</b></dt>
361
<span title="{'xi': 'xi', '>=': 'ge', 'lArr': 'lArr', 'Chi': 'Chi', 'omega': 'omega', 'ge': 'ge', 'sube': 'sube', 'asymp': 'asymp', 'otimes': 'otimes', 'zeta': 'zeta', 'prop': 'prop', 'Nu': 'Nu', 'equiv': 'equiv', 'Psi': 'Psi', 'integral': 'int', 'cup': 'cup', 'chi': 'chi', 'Eta': 'Eta', 'Beta': 'Beta', 'perp': 'perp', 'Delta': 'Delta', 'there4': 'there4', 'Upsilon': 'Upsilon', 'Lambda': 'Lambda', 'iota': 'iota', 'empty': 'empty', 'notin': 'notin', 'Kappa': 'Kappa', 'darr': 'darr', 'sup': 'sup', 'part': 'part', 'delta': 'delta', 'upsilon': 'upsilon', 'copy': 'copy', '^': 'uarr', 'Tau': 'Tau', 'Xi': 'Xi'..."> <dt><b>Value:</b></dt>
363
<pre class="variable">
372
<span class="variable-ellipsis">...</span> </pre>
373
</td></tr></table></dd>
376
</dl></td></tr></table>
377
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
378
<a name="SYMBOL_TO_LATEX"></a>
379
<h3>SYMBOL_TO_LATEX</h3>
384
<dt><b>Type:</b></dt>
389
<span title="{'xi': '\\(\\xi\\)', '>=': '\\(\\ge\\)', 'lArr': '\\(\\Leftarrow\\)', 'Chi': '\\(\\chi\\)', 'omega': '\\(\\omega\\)', 'ge': '\\(\\ge\\)', 'sube': '\\(\\subseteq\\)', 'asymp': '\\(\\approx\\)', 'otimes': '\\(\\otimes\\)', 'zeta': '\\(\\zeta\\)', 'prop': '\\(\\propto\\)', 'Nu': '\\(\\nu\\)', 'equiv': '\\(\\equiv\\)', 'Psi': '\\(\\Psi\\)', 'integral': '\\(\\int\\)', 'cup': '\\(\\cup\\)', 'chi': '\\(\\chi\\)', 'Eta': '\\(\\eta\\)', 'Beta': '\\(\\beta\\)', 'perp': '\\(\\perp\\)', 'Delta': '\\(\\Delta\\)', 'there4': '\\(\\therefore\\)', 'Upsilon': '\\(\\Upsilon\\)', 'Lambda': '\\(\\Lambda\\)', 'i..."> <dt><b>Value:</b></dt>
391
<pre class="variable">
392
{'>=': '\\(\\ge\\)',
393
'Chi': '\\(\\chi\\)',
394
'asymp': '\\(\\approx\\)',
396
'lArr': '\\(\\Leftarrow\\)',
397
'omega': '\\(\\omega\\)',
398
'otimes': '\\(\\otimes\\)',
399
'sube': '\\(\\subseteq\\)',
400
<span class="variable-ellipsis">...</span> </pre>
401
</td></tr></table></dd>
404
</dl></td></tr></table>
408
<!-- =========== START OF NAVBAR =========== -->
409
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
411
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
412
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
413
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
414
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
415
<th class="navbar" align="right" width="100%">
416
<table border="0" cellpadding="0" cellspacing="0">
417
<tr><th class="navbar" align="center">
419
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
420
</p></th></tr></table>
425
<table border="0" cellpadding="0" cellspacing="0" width="100%">
427
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:18 2004</font></td>
428
<td align="right"><a href="http://epydoc.sourceforge.net"
429
><font size="-2">http://epydoc.sf.net</font></a></td>
added
removed
doc/api/public/epydoc.markup.epytext.ParsedEpytextDocstring-class.html
