1
<?xml version="1.0" encoding="ascii"?>
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.plaintext.ParsedPlaintextDocstring</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="epydoc-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
45
<a href="epydoc-module.html">Package epydoc</a> ::
46
<a href="epydoc.markup-module.html">Package markup</a> ::
47
<a href="epydoc.markup.plaintext-module.html">Module plaintext</a> ::
48
Class ParsedPlaintextDocstring
52
<table cellpadding="0" cellspacing="0">
53
<!-- hide/show private -->
54
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55
onclick="toggle_private();">hide private</a>]</span></td></tr>
56
<tr><td align="right"><span class="options"
57
>[<a href="frames.html" target="_top">frames</a
58
>] | <a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html"
59
target="_top">no frames</a>]</span></td></tr>
64
<!-- ==================== CLASS DESCRIPTION ==================== -->
65
<h1 class="epydoc">Class ParsedPlaintextDocstring</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring">source code</a></span></p>
67
<center> <map id="uml_class_diagram_for_epydoc_m_14" name="uml_class_diagram_for_epydoc_m_14">
68
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#split_fields" title="Split this docstring into its body and its fields." alt="" coords="60,36,241,55" />
69
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#concatenate" title="Returns: A new parsed docstring containing the concatination of this docstring and other." alt="" coords="60,55,241,73" />
70
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#__add__" title="epydoc.markup.ParsedDocstring.__add__" alt="" coords="60,73,241,92" />
71
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#index_terms" title="Returns: The list of index terms that are defined in this docstring." alt="" coords="60,92,241,111" />
72
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html" title="A standard intermediate representation for parsed docstrings that can be used to generate output." alt="" coords="48,5,253,117" />
73
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__" title="epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__" alt="" coords="17,167,284,185" />
74
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html" title="Translate this docstring to HTML." alt="" coords="17,185,284,204" />
75
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_latex" title="Translate this docstring to LaTeX." alt="" coords="17,204,284,223" />
76
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext" title="Translate this docstring to plaintext." alt="" coords="17,223,284,241" />
77
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary" title="Returns: A pair consisting of a short summary of this docstring and a boolean value indicating whether there is further documentation in addition to the summary." alt="" coords="17,241,284,260" />
78
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html" title="epydoc.markup.plaintext.ParsedPlaintextDocstring" alt="" coords="5,136,296,267" />
80
<img src="uml_class_diagram_for_epydoc_m_14.gif" alt='' usemap="#uml_class_diagram_for_epydoc_m_14" ismap="ismap" class="graph-without-title" />
84
<!-- ==================== INSTANCE METHODS ==================== -->
85
<a name="section-InstanceMethods"></a>
86
<table class="summary" border="1" cellpadding="3"
87
cellspacing="0" width="100%" bgcolor="white">
88
<tr bgcolor="#70b0f0" class="table-header">
89
<td colspan="2" class="table-header">
90
<table border="0" cellpadding="0" cellspacing="0" width="100%">
92
<td align="left"><span class="table-header">Instance Methods</span></td>
93
<td align="right" valign="top"
94
><span class="options">[<a href="#section-InstanceMethods"
95
class="privatelink" onclick="toggle_private();"
96
>hide private</a>]</span></td>
102
<td width="15%" align="right" valign="top" class="summary">
103
<span class="summary-type"> </span>
104
</td><td class="summary">
105
<table width="100%" cellpadding="0" cellspacing="0" border="0">
107
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
108
<span class="summary-sig-arg">text</span>,
109
<span class="summary-sig-arg">**options</span>)</span></td>
110
<td align="right" valign="top">
111
<span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.__init__">source code</a></span>
112
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___38-summary-div');return false;">call graph</a></span>
116
<div style="display:none" id="call_graph_for___init___38-summary-div"><center>
117
<table border="0" cellpadding="0" cellspacing="0">
118
<tr><td><center> <map id="call_graph_for___init___38" name="call_graph_for___init___38">
119
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__" title="__init__()" alt="" coords="209,34,305,66" />
120
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary" title="summary()" alt="" coords="31,6,135,38" />
121
<area shape="rect" href="epydoc.markup.plaintext-module.html#parse_docstring" title="parse_docstring()" alt="" coords="7,62,159,94" />
123
<img src="call_graph_for___init___38.gif" alt='' usemap="#call_graph_for___init___38" ismap="ismap" class="graph-without-title" />
125
<tr><th>Call Graph</th></tr>
132
<td width="15%" align="right" valign="top" class="summary">
133
<span class="summary-type"><code>string</code></span>
134
</td><td class="summary">
135
<table width="100%" cellpadding="0" cellspacing="0" border="0">
137
<td><span class="summary-sig"><a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html" class="summary-sig-name">to_html</a>(<span class="summary-sig-arg">self</span>,
138
<span class="summary-sig-arg">docstring_linker</span>,
139
<span class="summary-sig-arg">**options</span>)</span><br />
140
Translate this docstring to HTML.</td>
141
<td align="right" valign="top">
142
<span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.to_html">source code</a></span>
143
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_html_6-summary-div');return false;">call graph</a></span>
147
<div style="display:none" id="call_graph_for_to_html_6-summary-div"><center>
148
<table border="0" cellpadding="0" cellspacing="0">
149
<tr><td><center> <map id="call_graph_for_to_html_6" name="call_graph_for_to_html_6">
150
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#description" title="docwriter.html.HTMLWriter.description()" alt="" coords="33,34,369,66" />
151
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html" title="to_html()" alt="" coords="447,62,537,94" />
152
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docwriter.html.HTMLWriter.docstring_to_html()" alt="" coords="7,90,396,122" />
153
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#to_html" title="ParsedDocstring.to_html()" alt="" coords="588,6,807,38" />
154
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext" title="to_plaintext()" alt="" coords="636,62,759,94" />
155
<area shape="rect" href="epydoc.util-module.html#plaintext_to_html" title="util.plaintext_to_html()" alt="" coords="599,118,796,150" />
157
<img src="call_graph_for_to_html_6.gif" alt='' usemap="#call_graph_for_to_html_6" ismap="ismap" class="graph-without-title" />
159
<tr><th>Call Graph</th></tr>
166
<td width="15%" align="right" valign="top" class="summary">
167
<span class="summary-type"><code>string</code></span>
168
</td><td class="summary">
169
<table width="100%" cellpadding="0" cellspacing="0" border="0">
171
<td><span class="summary-sig"><a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_latex" class="summary-sig-name">to_latex</a>(<span class="summary-sig-arg">self</span>,
172
<span class="summary-sig-arg">docstring_linker</span>,
173
<span class="summary-sig-arg">**options</span>)</span><br />
174
Translate this docstring to LaTeX.</td>
175
<td align="right" valign="top">
176
<span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.to_latex">source code</a></span>
185
<td width="15%" align="right" valign="top" class="summary">
186
<span class="summary-type"><code>string</code></span>
187
</td><td class="summary">
188
<table width="100%" cellpadding="0" cellspacing="0" border="0">
190
<td><span class="summary-sig"><a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext" class="summary-sig-name">to_plaintext</a>(<span class="summary-sig-arg">self</span>,
191
<span class="summary-sig-arg">docstring_linker</span>,
192
<span class="summary-sig-arg">**options</span>)</span><br />
193
Translate this docstring to plaintext.</td>
194
<td align="right" valign="top">
195
<span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.to_plaintext">source code</a></span>
196
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_plaintext_6-summary-div');return false;">call graph</a></span>
200
<div style="display:none" id="call_graph_for_to_plaintext_6-summary-div"><center>
201
<table border="0" cellpadding="0" cellspacing="0">
202
<tr><td><center> <map id="call_graph_for_to_plaintext_6" name="call_graph_for_to_plaintext_6">
203
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#_summary" title="docwriter.dotgraph.DotGraphUmlClassNode._summary()" alt="" coords="7,6,458,38" />
204
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext" title="to_plaintext()" alt="" coords="507,62,630,94" />
205
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#to_html" title="ParsedDocstring.to_html()" alt="" coords="123,62,342,94" />
206
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html" title="to_html()" alt="" coords="187,118,278,150" />
208
<img src="call_graph_for_to_plaintext_6.gif" alt='' usemap="#call_graph_for_to_plaintext_6" ismap="ismap" class="graph-without-title" />
210
<tr><th>Call Graph</th></tr>
217
<td width="15%" align="right" valign="top" class="summary">
218
<span class="summary-type">(<a href="epydoc.markup.ParsedDocstring-class.html"
219
class="link">ParsedDocstring</a>, <code>bool</code>)</span>
220
</td><td class="summary">
221
<table width="100%" cellpadding="0" cellspacing="0" border="0">
223
<td><span class="summary-sig"><a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary" class="summary-sig-name">summary</a>(<span class="summary-sig-arg">self</span>)</span><br />
225
A pair consisting of a short summary of this docstring and a boolean
226
value indicating whether there is further documentation in addition
228
<td align="right" valign="top">
229
<span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.summary">source code</a></span>
230
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_summary_6-summary-div');return false;">call graph</a></span>
234
<div style="display:none" id="call_graph_for_summary_6-summary-div"><center>
235
<table border="0" cellpadding="0" cellspacing="0">
236
<tr><td><center> <map id="call_graph_for_summary_6" name="call_graph_for_summary_6">
237
<area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="5,6,277,38" />
238
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary" title="summary()" alt="" coords="325,6,429,38" />
239
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__" title="__init__()" alt="" coords="479,6,575,38" />
241
<img src="call_graph_for_summary_6.gif" alt='' usemap="#call_graph_for_summary_6" ismap="ismap" class="graph-without-title" />
243
<tr><th>Call Graph</th></tr>
250
<td colspan="2" class="summary">
251
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.markup.ParsedDocstring-class.html">ParsedDocstring</a></code></b>:
252
<code><a href="epydoc.markup.ParsedDocstring-class.html#__add__">__add__</a></code>,
253
<code><a href="epydoc.markup.ParsedDocstring-class.html#concatenate">concatenate</a></code>,
254
<code><a href="epydoc.markup.ParsedDocstring-class.html#index_terms">index_terms</a></code>,
255
<code><a href="epydoc.markup.ParsedDocstring-class.html#split_fields">split_fields</a></code>
260
<!-- ==================== CLASS VARIABLES ==================== -->
261
<a name="section-ClassVariables"></a>
262
<table class="summary" border="1" cellpadding="3"
263
cellspacing="0" width="100%" bgcolor="white">
264
<tr bgcolor="#70b0f0" class="table-header">
265
<td colspan="2" class="table-header">
266
<table border="0" cellpadding="0" cellspacing="0" width="100%">
268
<td align="left"><span class="table-header">Class Variables</span></td>
269
<td align="right" valign="top"
270
><span class="options">[<a href="#section-ClassVariables"
271
class="privatelink" onclick="toggle_private();"
272
>hide private</a>]</span></td>
278
<td width="15%" align="right" valign="top" class="summary">
279
<span class="summary-type"> </span>
280
</td><td class="summary">
281
<a name="_SUMMARY_RE"></a><span class="summary-name">_SUMMARY_RE</span> = <code title="re.compile(r'(\s*[\w\W]*?(?:\.(\s|$)|\n[\t ]*\n))')">re.compile(r'<code class="re-group">(</code>\s<code class="re-op">*</code><code class="re-group">[</code>\w\W<code class="re-group">]</code><code class="re-op">*?</code><code class="re-group">(?:</code>\.<code class="re-group">(</code>\s<code class="re-op">|</code>$<code class="re-group">)</code><code class="re-op">|</code>\n<code class="re-group">[</code>\t <code class="re-group">]</code><code class="re-op">*</code>\n<code class="re-group">)</code><code class="re-group">)</code>')</code>
285
<!-- ==================== METHOD DETAILS ==================== -->
286
<a name="section-MethodDetails"></a>
287
<table class="details" border="1" cellpadding="3"
288
cellspacing="0" width="100%" bgcolor="white">
289
<tr bgcolor="#70b0f0" class="table-header">
290
<td colspan="2" class="table-header">
291
<table border="0" cellpadding="0" cellspacing="0" width="100%">
293
<td align="left"><span class="table-header">Method Details</span></td>
294
<td align="right" valign="top"
295
><span class="options">[<a href="#section-MethodDetails"
296
class="privatelink" onclick="toggle_private();"
297
>hide private</a>]</span></td>
303
<a name="to_html"></a>
305
<table class="details" border="1" cellpadding="3"
306
cellspacing="0" width="100%" bgcolor="white">
308
<table width="100%" cellpadding="0" cellspacing="0" border="0">
309
<tr valign="top"><td>
310
<h3 class="epydoc"><span class="sig"><span class="sig-name">to_html</span>(<span class="sig-arg">self</span>,
311
<span class="sig-arg">docstring_linker</span>,
312
<span class="sig-arg">**options</span>)</span>
314
</td><td align="right" valign="top"
315
><span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.to_html">source code</a></span>
316
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_html_6-div');return false;">call graph</a></span> </td>
318
<div style="display:none" id="call_graph_for_to_html_6-div"><center>
319
<table border="0" cellpadding="0" cellspacing="0">
320
<tr><td><center> <map id="call_graph_for_to_html_6" name="call_graph_for_to_html_6">
321
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#description" title="docwriter.html.HTMLWriter.description()" alt="" coords="33,34,369,66" />
322
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html" title="to_html()" alt="" coords="447,62,537,94" />
323
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docwriter.html.HTMLWriter.docstring_to_html()" alt="" coords="7,90,396,122" />
324
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#to_html" title="ParsedDocstring.to_html()" alt="" coords="588,6,807,38" />
325
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext" title="to_plaintext()" alt="" coords="636,62,759,94" />
326
<area shape="rect" href="epydoc.util-module.html#plaintext_to_html" title="util.plaintext_to_html()" alt="" coords="599,118,796,150" />
328
<img src="call_graph_for_to_html_6.gif" alt='' usemap="#call_graph_for_to_html_6" ismap="ismap" class="graph-without-title" />
330
<tr><th>Call Graph</th></tr>
334
<p>Translate this docstring to HTML.</p>
337
<dd><ul class="nomargin-top">
338
<li><strong class="pname"><code>docstring_linker</code></strong> - An HTML translator for crossreference links into and out of the
340
<li><strong class="pname"><code>options</code></strong> - Any extra options for the output. Unknown options are ignored.</li>
342
<dt>Returns: <code>string</code></dt>
343
<dd>An HTML fragment that encodes this docstring.</dd>
345
<a href="epydoc.markup.ParsedDocstring-class.html#to_html">ParsedDocstring.to_html</a>
346
<dd><em class="note">(inherited documentation)</em></dd>
351
<a name="to_latex"></a>
353
<table class="details" border="1" cellpadding="3"
354
cellspacing="0" width="100%" bgcolor="white">
356
<table width="100%" cellpadding="0" cellspacing="0" border="0">
357
<tr valign="top"><td>
358
<h3 class="epydoc"><span class="sig"><span class="sig-name">to_latex</span>(<span class="sig-arg">self</span>,
359
<span class="sig-arg">docstring_linker</span>,
360
<span class="sig-arg">**options</span>)</span>
362
</td><td align="right" valign="top"
363
><span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.to_latex">source code</a></span>
367
<p>Translate this docstring to LaTeX.</p>
370
<dd><ul class="nomargin-top">
371
<li><strong class="pname"><code>docstring_linker</code></strong> - A LaTeX translator for crossreference links into and out of the
373
<li><strong class="pname"><code>options</code></strong> - Any extra options for the output. Unknown options are ignored.</li>
375
<dt>Returns: <code>string</code></dt>
376
<dd>A LaTeX fragment that encodes this docstring.</dd>
378
<a href="epydoc.markup.ParsedDocstring-class.html#to_latex">ParsedDocstring.to_latex</a>
379
<dd><em class="note">(inherited documentation)</em></dd>
384
<a name="to_plaintext"></a>
386
<table class="details" border="1" cellpadding="3"
387
cellspacing="0" width="100%" bgcolor="white">
389
<table width="100%" cellpadding="0" cellspacing="0" border="0">
390
<tr valign="top"><td>
391
<h3 class="epydoc"><span class="sig"><span class="sig-name">to_plaintext</span>(<span class="sig-arg">self</span>,
392
<span class="sig-arg">docstring_linker</span>,
393
<span class="sig-arg">**options</span>)</span>
395
</td><td align="right" valign="top"
396
><span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.to_plaintext">source code</a></span>
397
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_plaintext_6-div');return false;">call graph</a></span> </td>
399
<div style="display:none" id="call_graph_for_to_plaintext_6-div"><center>
400
<table border="0" cellpadding="0" cellspacing="0">
401
<tr><td><center> <map id="call_graph_for_to_plaintext_6" name="call_graph_for_to_plaintext_6">
402
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#_summary" title="docwriter.dotgraph.DotGraphUmlClassNode._summary()" alt="" coords="7,6,458,38" />
403
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext" title="to_plaintext()" alt="" coords="507,62,630,94" />
404
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#to_html" title="ParsedDocstring.to_html()" alt="" coords="123,62,342,94" />
405
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html" title="to_html()" alt="" coords="187,118,278,150" />
407
<img src="call_graph_for_to_plaintext_6.gif" alt='' usemap="#call_graph_for_to_plaintext_6" ismap="ismap" class="graph-without-title" />
409
<tr><th>Call Graph</th></tr>
413
<p>Translate this docstring to plaintext.</p>
416
<dd><ul class="nomargin-top">
417
<li><strong class="pname"><code>docstring_linker</code></strong> - A plaintext translator for crossreference links into and out of
419
<li><strong class="pname"><code>options</code></strong> - Any extra options for the output. Unknown options are ignored.</li>
421
<dt>Returns: <code>string</code></dt>
422
<dd>A plaintext fragment that encodes this docstring.</dd>
424
<a href="epydoc.markup.ParsedDocstring-class.html#to_plaintext">ParsedDocstring.to_plaintext</a>
425
<dd><em class="note">(inherited documentation)</em></dd>
430
<a name="summary"></a>
432
<table class="details" border="1" cellpadding="3"
433
cellspacing="0" width="100%" bgcolor="white">
435
<table width="100%" cellpadding="0" cellspacing="0" border="0">
436
<tr valign="top"><td>
437
<h3 class="epydoc"><span class="sig"><span class="sig-name">summary</span>(<span class="sig-arg">self</span>)</span>
439
</td><td align="right" valign="top"
440
><span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#ParsedPlaintextDocstring.summary">source code</a></span>
441
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_summary_6-div');return false;">call graph</a></span> </td>
443
<div style="display:none" id="call_graph_for_summary_6-div"><center>
444
<table border="0" cellpadding="0" cellspacing="0">
445
<tr><td><center> <map id="call_graph_for_summary_6" name="call_graph_for_summary_6">
446
<area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="5,6,277,38" />
447
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary" title="summary()" alt="" coords="325,6,429,38" />
448
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__" title="__init__()" alt="" coords="479,6,575,38" />
450
<img src="call_graph_for_summary_6.gif" alt='' usemap="#call_graph_for_summary_6" ismap="ismap" class="graph-without-title" />
452
<tr><th>Call Graph</th></tr>
458
<dt>Returns: (<a href="epydoc.markup.ParsedDocstring-class.html"
459
class="link">ParsedDocstring</a>, <code>bool</code>)</dt>
460
<dd>A pair consisting of a short summary of this docstring and a
461
boolean value indicating whether there is further documentation
462
in addition to the summary. Typically, the summary consists of
463
the first sentence of the docstring.</dd>
465
<a href="epydoc.markup.ParsedDocstring-class.html#summary">ParsedDocstring.summary</a>
466
<dd><em class="note">(inherited documentation)</em></dd>
472
<!-- ==================== NAVIGATION BAR ==================== -->
473
<table class="navbar" border="0" width="100%" cellpadding="0"
474
bgcolor="#a0c0ff" cellspacing="0">
477
<th> <a
478
href="epydoc-module.html">Home</a> </th>
481
<th> <a
482
href="module-tree.html">Trees</a> </th>
485
<th> <a
486
href="identifier-index.html">Indices</a> </th>
489
<th> <a
490
href="help.html">Help</a> </th>
492
<!-- Project homepage -->
493
<th class="navbar" align="right" width="100%">
494
<table border="0" cellpadding="0" cellspacing="0">
495
<tr><th class="navbar" align="center"
496
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
500
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
502
<td align="left" class="footer">
503
<a href="epydoc-log.html">Generated by Epydoc
504
3.0.1 on Wed Jan 30 14:08:39 2008</a>
506
<td align="right" class="footer">
507
<a target="mainFrame" href="http://epydoc.sourceforge.net"
508
>http://epydoc.sourceforge.net</a>
513
<script type="text/javascript">
515
// Private objects are initially displayed (because if
516
// javascript is turned off then we want them to be
517
// visible); but by default, we want to hide them. So hide
518
// them unless we have a cookie that says to show them.
added
removed
doc/api/epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html
