← Back to branch summary

~ubuntu-branches/debian/lenny/epydoc/lenny

« back to all changes in this revision

Viewing changes to doc/api/epydoc.markup.ConcatenatedDocstring-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2008-02-03 13:22:12 UTC
  • mfrom: (1.2.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080203132212-u2uohl6rswmlz2ra
Tags: 3.0.1-1
* New upstream release.
* Removed #! from top of epydoc/gui.py
* Got rid of version mangling in debian/watch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/epydoc.markup.ConcatenatedDocstring-class.html
 
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">
 
5
<head>
 
6
  <title>epydoc.markup.ConcatenatedDocstring</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
  <script type="text/javascript" src="epydoc.js"></script>
 
9
</head>
 
10
 
 
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
12
      alink="#204080">
 
13
<!-- ==================== NAVIGATION BAR ==================== -->
 
14
<table class="navbar" border="0" width="100%" cellpadding="0"
 
15
       bgcolor="#a0c0ff" cellspacing="0">
 
16
  <tr valign="middle">
 
17
  <!-- Home link -->
 
18
      <th>&nbsp;&nbsp;&nbsp;<a
 
19
        href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
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>
 
38
          </tr></table></th>
 
39
  </tr>
 
40
</table>
 
41
<table width="100%" cellpadding="0" cellspacing="0">
 
42
  <tr valign="top">
 
43
    <td width="100%">
 
44
      <span class="breadcrumbs">
 
45
        <a href="epydoc-module.html">Package&nbsp;epydoc</a> ::
 
46
        <a href="epydoc.markup-module.html">Package&nbsp;markup</a> ::
 
47
        Class&nbsp;ConcatenatedDocstring
 
48
      </span>
 
49
    </td>
 
50
    <td>
 
51
      <table cellpadding="0" cellspacing="0">
 
52
        <!-- hide/show private -->
 
53
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 
54
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 
55
        <tr><td align="right"><span class="options"
 
56
            >[<a href="frames.html" target="_top">frames</a
 
57
            >]&nbsp;|&nbsp;<a href="epydoc.markup.ConcatenatedDocstring-class.html"
 
58
            target="_top">no&nbsp;frames</a>]</span></td></tr>
 
59
      </table>
 
60
    </td>
 
61
  </tr>
 
62
</table>
 
63
<!-- ==================== CLASS DESCRIPTION ==================== -->
 
64
<h1 class="epydoc">Class ConcatenatedDocstring</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring">source&nbsp;code</a></span></p>
 
65
<!-- ==================== INSTANCE METHODS ==================== -->
 
66
<a name="section-InstanceMethods"></a>
 
67
<table class="summary" border="1" cellpadding="3"
 
68
       cellspacing="0" width="100%" bgcolor="white">
 
69
<tr bgcolor="#70b0f0" class="table-header">
 
70
  <td colspan="2" class="table-header">
 
71
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
72
      <tr valign="top">
 
73
        <td align="left"><span class="table-header">Instance Methods</span></td>
 
74
        <td align="right" valign="top"
 
75
         ><span class="options">[<a href="#section-InstanceMethods"
 
76
         class="privatelink" onclick="toggle_private();"
 
77
         >hide private</a>]</span></td>
 
78
      </tr>
 
79
    </table>
 
80
  </td>
 
81
</tr>
 
82
<tr>
 
83
    <td width="15%" align="right" valign="top" class="summary">
 
84
      <span class="summary-type">&nbsp;</span>
 
85
    </td><td class="summary">
 
86
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
87
        <tr>
 
88
          <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
 
89
        <span class="summary-sig-arg">*parsed_docstrings</span>)</span></td>
 
90
          <td align="right" valign="top">
 
91
            <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.__init__">source&nbsp;code</a></span>
 
92
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___30-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
 
93
          </td>
 
94
        </tr>
 
95
      </table>
 
96
      <div style="display:none" id="call_graph_for___init___30-summary-div"><center>
 
97
<table border="0" cellpadding="0" cellspacing="0">
 
98
  <tr><td><center>  <map id="call_graph_for___init___30" name="call_graph_for___init___30">
 
99
<area shape="rect" href="epydoc.docstringparser&#45;module.html#process_cvar_field" title="docstringparser.process_cvar_field()" alt="" coords="7,6,300,38" />
 
100
<area shape="rect" href="epydoc.markup.ConcatenatedDocstring&#45;class.html#__init__" title="__init__()" alt="" coords="351,62,447,94" />
 
101
<area shape="rect" href="epydoc.docstringparser&#45;module.html#process_ivar_field" title="docstringparser.process_ivar_field()" alt="" coords="8,62,299,94" />
 
102
<area shape="rect" href="epydoc.markup.ParsedDocstring&#45;class.html#concatenate" title="ParsedDocstring.concatenate()" alt="" coords="28,118,279,150" />
 
103
</map>
 
104
  <img src="call_graph_for___init___30.gif" alt='' usemap="#call_graph_for___init___30" ismap="ismap" class="graph-without-title" />
 
105
</center></td></tr>
 
106
  <tr><th>Call Graph</th></tr>
 
107
</table><br />
 
108
</center></div>
 
109
 
 
110
    </td>
 
111
  </tr>
 
112
<tr>
 
113
    <td width="15%" align="right" valign="top" class="summary">
 
114
      <span class="summary-type">&nbsp;</span>
 
115
    </td><td class="summary">
 
116
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
117
        <tr>
 
118
          <td><span class="summary-sig"><a name="split_fields"></a><span class="summary-sig-name">split_fields</span>(<span class="summary-sig-arg">self</span>,
 
119
        <span class="summary-sig-arg">errors</span>=<span class="summary-sig-default">None</span>)</span></td>
 
120
          <td align="right" valign="top">
 
121
            <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.split_fields">source&nbsp;code</a></span>
 
122
            
 
123
          </td>
 
124
        </tr>
 
125
      </table>
 
126
      
 
127
    </td>
 
128
  </tr>
 
129
<tr>
 
130
    <td width="15%" align="right" valign="top" class="summary">
 
131
      <span class="summary-type">&nbsp;</span>
 
132
    </td><td class="summary">
 
133
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
134
        <tr>
 
135
          <td><span class="summary-sig"><a name="summary"></a><span class="summary-sig-name">summary</span>(<span class="summary-sig-arg">self</span>)</span></td>
 
136
          <td align="right" valign="top">
 
137
            <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.summary">source&nbsp;code</a></span>
 
138
            
 
139
          </td>
 
140
        </tr>
 
141
      </table>
 
142
      
 
143
    </td>
 
144
  </tr>
 
145
<tr>
 
146
    <td width="15%" align="right" valign="top" class="summary">
 
147
      <span class="summary-type">&nbsp;</span>
 
148
    </td><td class="summary">
 
149
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
150
        <tr>
 
151
          <td><span class="summary-sig"><a name="to_html"></a><span class="summary-sig-name">to_html</span>(<span class="summary-sig-arg">self</span>,
 
152
        <span class="summary-sig-arg">docstring_linker</span>,
 
153
        <span class="summary-sig-arg">**options</span>)</span></td>
 
154
          <td align="right" valign="top">
 
155
            <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.to_html">source&nbsp;code</a></span>
 
156
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_html_2-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
 
157
          </td>
 
158
        </tr>
 
159
      </table>
 
160
      <div style="display:none" id="call_graph_for_to_html_2-summary-div"><center>
 
161
<table border="0" cellpadding="0" cellspacing="0">
 
162
  <tr><td><center>  <map id="call_graph_for_to_html_2" name="call_graph_for_to_html_2">
 
163
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter&#45;class.html#docstring_to_html" title="docwriter.html.HTMLWriter.docstring_to_html()" alt="" coords="7,34,396,66" />
 
164
<area shape="rect" href="epydoc.markup.ConcatenatedDocstring&#45;class.html#to_html" title="to_html()" alt="" coords="447,34,537,66" />
 
165
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring&#45;class.html#to_html" title="epytext.ParsedEpytextDocstring.to_html()" alt="" coords="603,6,939,38" />
 
166
<area shape="rect" href="epydoc.markup.restructuredtext.ParsedRstDocstring&#45;class.html#to_html" title="restructuredtext.ParsedRstDocstring.to_html()" alt="" coords="588,62,953,94" />
 
167
</map>
 
168
  <img src="call_graph_for_to_html_2.gif" alt='' usemap="#call_graph_for_to_html_2" ismap="ismap" class="graph-without-title" />
 
169
</center></td></tr>
 
170
  <tr><th>Call Graph</th></tr>
 
171
</table><br />
 
172
</center></div>
 
173
 
 
174
    </td>
 
175
  </tr>
 
176
<tr>
 
177
    <td width="15%" align="right" valign="top" class="summary">
 
178
      <span class="summary-type">&nbsp;</span>
 
179
    </td><td class="summary">
 
180
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
181
        <tr>
 
182
          <td><span class="summary-sig"><a name="to_latex"></a><span class="summary-sig-name">to_latex</span>(<span class="summary-sig-arg">self</span>,
 
183
        <span class="summary-sig-arg">docstring_linker</span>,
 
184
        <span class="summary-sig-arg">**options</span>)</span></td>
 
185
          <td align="right" valign="top">
 
186
            <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.to_latex">source&nbsp;code</a></span>
 
187
            
 
188
          </td>
 
189
        </tr>
 
190
      </table>
 
191
      
 
192
    </td>
 
193
  </tr>
 
194
<tr>
 
195
    <td width="15%" align="right" valign="top" class="summary">
 
196
      <span class="summary-type">&nbsp;</span>
 
197
    </td><td class="summary">
 
198
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
199
        <tr>
 
200
          <td><span class="summary-sig"><a name="to_plaintext"></a><span class="summary-sig-name">to_plaintext</span>(<span class="summary-sig-arg">self</span>,
 
201
        <span class="summary-sig-arg">docstring_linker</span>,
 
202
        <span class="summary-sig-arg">**options</span>)</span></td>
 
203
          <td align="right" valign="top">
 
204
            <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.to_plaintext">source&nbsp;code</a></span>
 
205
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_plaintext_2-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
 
206
          </td>
 
207
        </tr>
 
208
      </table>
 
209
      <div style="display:none" id="call_graph_for_to_plaintext_2-summary-div"><center>
 
210
<table border="0" cellpadding="0" cellspacing="0">
 
211
  <tr><td><center>  <map id="call_graph_for_to_plaintext_2" name="call_graph_for_to_plaintext_2">
 
212
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode&#45;class.html#_summary" title="docwriter.dotgraph.DotGraphUmlClassNode._summary()" alt="" coords="7,6,458,38" />
 
213
<area shape="rect" href="epydoc.markup.ConcatenatedDocstring&#45;class.html#to_plaintext" title="to_plaintext()" alt="" coords="507,6,630,38" />
 
214
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring&#45;class.html#to_plaintext" title="epytext.ParsedEpytextDocstring.to_plaintext()" alt="" coords="678,6,1046,38" />
 
215
</map>
 
216
  <img src="call_graph_for_to_plaintext_2.gif" alt='' usemap="#call_graph_for_to_plaintext_2" ismap="ismap" class="graph-without-title" />
 
217
</center></td></tr>
 
218
  <tr><th>Call Graph</th></tr>
 
219
</table><br />
 
220
</center></div>
 
221
 
 
222
    </td>
 
223
  </tr>
 
224
<tr>
 
225
    <td width="15%" align="right" valign="top" class="summary">
 
226
      <span class="summary-type">&nbsp;</span>
 
227
    </td><td class="summary">
 
228
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
229
        <tr>
 
230
          <td><span class="summary-sig"><a name="index_terms"></a><span class="summary-sig-name">index_terms</span>(<span class="summary-sig-arg">self</span>)</span></td>
 
231
          <td align="right" valign="top">
 
232
            <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.index_terms">source&nbsp;code</a></span>
 
233
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_index_terms-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
 
234
          </td>
 
235
        </tr>
 
236
      </table>
 
237
      <div style="display:none" id="call_graph_for_index_terms-summary-div"><center>
 
238
<table border="0" cellpadding="0" cellspacing="0">
 
239
  <tr><td><center>  <map id="call_graph_for_index_terms" name="call_graph_for_index_terms">
 
240
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter&#45;class.html#_terms_from_docstring" title="docwriter.html.HTMLWriter._terms_from_docstring()" alt="" coords="6,6,435,38" />
 
241
<area shape="rect" href="epydoc.markup.ConcatenatedDocstring&#45;class.html#index_terms" title="index_terms()" alt="" coords="483,6,611,38" />
 
242
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring&#45;class.html#index_terms" title="epytext.ParsedEpytextDocstring.index_terms()" alt="" coords="659,6,1030,38" />
 
243
</map>
 
244
  <img src="call_graph_for_index_terms.gif" alt='' usemap="#call_graph_for_index_terms" ismap="ismap" class="graph-without-title" />
 
245
</center></td></tr>
 
246
  <tr><th>Call Graph</th></tr>
 
247
</table><br />
 
248
</center></div>
 
249
 
 
250
    </td>
 
251
  </tr>
 
252
</table>
 
253
<!-- ==================== NAVIGATION BAR ==================== -->
 
254
<table class="navbar" border="0" width="100%" cellpadding="0"
 
255
       bgcolor="#a0c0ff" cellspacing="0">
 
256
  <tr valign="middle">
 
257
  <!-- Home link -->
 
258
      <th>&nbsp;&nbsp;&nbsp;<a
 
259
        href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
260
 
 
261
  <!-- Tree link -->
 
262
      <th>&nbsp;&nbsp;&nbsp;<a
 
263
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
264
 
 
265
  <!-- Index link -->
 
266
      <th>&nbsp;&nbsp;&nbsp;<a
 
267
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
268
 
 
269
  <!-- Help link -->
 
270
      <th>&nbsp;&nbsp;&nbsp;<a
 
271
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
272
 
 
273
  <!-- Project homepage -->
 
274
      <th class="navbar" align="right" width="100%">
 
275
        <table border="0" cellpadding="0" cellspacing="0">
 
276
          <tr><th class="navbar" align="center"
 
277
            ><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
 
278
          </tr></table></th>
 
279
  </tr>
 
280
</table>
 
281
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
282
  <tr>
 
283
    <td align="left" class="footer">
 
284
    <a href="epydoc-log.html">Generated by Epydoc
 
285
    3.0.1 on Wed Jan 30 14:08:23 2008</a>
 
286
    </td>
 
287
    <td align="right" class="footer">
 
288
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
289
        >http://epydoc.sourceforge.net</a>
 
290
    </td>
 
291
  </tr>
 
292
</table>
 
293
 
 
294
<script type="text/javascript">
 
295
  <!--
 
296
  // Private objects are initially displayed (because if
 
297
  // javascript is turned off then we want them to be
 
298
  // visible); but by default, we want to hide them.  So hide
 
299
  // them unless we have a cookie that says to show them.
 
300
  checkCookie();
 
301
  // -->
 
302
</script>
 
303
</body>
 
304
</html>