File: epydoc.markup.javadoc.ParsedJavadocDocstring-class.html

package info (click to toggle)
epydoc 2.1-8
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 5,364 kB
  • ctags: 2,878
  • sloc: python: 9,010; makefile: 85; sh: 73
file content (468 lines) | stat: -rw-r--r-- 23,038 bytes parent folder | download | duplicates (2)
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
<?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.javadoc.ParsedJavadocDocstring</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;epydoc</a> ::
        <a href="epydoc.markup-module.html">Package&nbsp;markup</a> ::
        <a href="epydoc.markup.javadoc-module.html">Module&nbsp;javadoc</a> ::
        Class&nbsp;ParsedJavadocDocstring
      </b></font></br>
    </td>
    <td><table cellpadding="0" cellspacing="0">
      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/epydoc.markup.javadoc.ParsedJavadocDocstring-class.html">hide&nbsp;private</a>]</font></td></tr>
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="epydoc.markup.javadoc.ParsedJavadocDocstring-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class ParsedJavadocDocstring</h2>

<pre class="base-tree">
<a href="epydoc.markup.ParsedDocstring-class.html"><code>ParsedDocstring</code></a> --+
                  |
                 <b>ParsedJavadocDocstring</b>
</pre><br />

<hr/>

An encoded version of a Javadoc docstring. Since Javadoc is a fairly 
simple markup language, we don't do any processing in advance; instead, 
we wait to split fields or resolve crossreference links until we need 
to.
<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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>docstring</span>,
          <span class=summary-sig-arg>errors</span>)</span></code>
<br />
Create a new <code>ParsedJavadocDocstring</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="epydoc.markup.javadoc.ParsedJavadocDocstring-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">        <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.javadoc.ParsedJavadocDocstring-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.javadoc.ParsedJavadocDocstring-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>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="../private/epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#_check_links" class="summary-sig-name"><code>_check_links</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>errors</span>)</span></code>
<br />
Make sure that all &#64;{link}s are valid.</td></tr>
  <tr><td colspan="2">
    <b>Inherited from <a href="epydoc.markup.ParsedDocstring-class.html"><code>ParsedDocstring</code></a>:</b>
      <a href="epydoc.markup.ParsedDocstring-class.html#__add__"><code>__add__</code></a>, 
      <a href="epydoc.markup.ParsedDocstring-class.html#index_terms"><code>index_terms</code></a>, 
      <a href="epydoc.markup.ParsedDocstring-class.html#to_latex"><code>to_latex</code></a>
    </td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Field Splitting</th></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.javadoc.ParsedJavadocDocstring-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 bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;HTML Output</th></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.javadoc.ParsedJavadocDocstring-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>
</table><br />


<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Class Variable Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Field Splitting</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="../private/epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#_ARG_FIELDS"><code>_ARG_FIELDS</code></a></b>: A list of the fields that take arguments.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="../private/epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#_FIELD_RE"><code>_FIELD_RE</code></a></b>: A regular expression used to search for Javadoc block tags.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;HTML Output</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="../private/epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#_LINK_SPLIT_RE"><code>_LINK_SPLIT_RE</code></a></b>: A regular expression used to search for Javadoc inline tags.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="../private/epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#_LINK_RE"><code>_LINK_RE</code></a></b>: A regular expression used to process Javadoc inline tags.</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="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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (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>
    <dl><dt><b>Overrides:</b></dt>
      <dd><a href="epydoc.markup.ParsedDocstring-class.html#split_fields"><code>epydoc.markup.ParsedDocstring.split_fields</code></a> <i>(inherited documentation)</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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<code>string</code>)</i>
      </dd>
    </dl>
    <dl><dt><b>Overrides:</b></dt>
      <dd><a href="epydoc.markup.ParsedDocstring-class.html#to_html"><code>epydoc.markup.ParsedDocstring.to_html</code></a> <i>(inherited documentation)</i>
</dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>docstring</span>,
          <span class=sig-arg>errors</span>=<span class=sig-default>None</span>)</span>
    <br /><i>(Constructor)</i>
  </h3>
  Create a new <code>ParsedJavadocDocstring</code>.
  <dl><dt></dt><dd>
    <dl><dt><b>Parameters:</b></dt>
      <dd><code><b>docstring</b></code> -
         The docstring that should be used to construct this 
        <code>ParsedJavadocDocstring</code>.
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<code>string</code>)</i>
      <dd><code><b>errors</b></code> -
         A list where any errors generated during parsing will be 
        stored. If no list is given, then all errors are ignored.
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<code>list</code> of <a 
              href="epydoc.markup.ParseError-class.html" 
              class="link"><code>ParseError</code></a>)</i>
      </dd>
    </dl>
  </dd></dl>
</td></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>
    <dl><dt><b>Overrides:</b></dt>
      <dd><a href="epydoc.markup.ParsedDocstring-class.html#concatenate"><code>epydoc.markup.ParsedDocstring.concatenate</code></a> <i>(inherited documentation)</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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<a href="epydoc.markup.ParsedDocstring-class.html" 
        class="link"><code>ParsedDocstring</code></a>)</i>
      </dd>
    </dl>
    <dl><dt><b>Overrides:</b></dt>
      <dd><a href="epydoc.markup.ParsedDocstring-class.html#summary"><code>epydoc.markup.ParsedDocstring.summary</code></a> <i>(inherited documentation)</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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<code>string</code>)</i>
      </dd>
    </dl>
    <dl><dt><b>Overrides:</b></dt>
      <dd><a href="epydoc.markup.ParsedDocstring-class.html#to_plaintext"><code>epydoc.markup.ParsedDocstring.to_plaintext</code></a> <i>(inherited documentation)</i>
</dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="_check_links"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">_check_links</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>errors</span>)</span>
  </h3>
  Make sure that all &#64;{link}s are valid. We need a separate method 
  for ths because we want to do this at parse time, not html output time. 
  Any errors found are appended to <code>errors</code>.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
<br />


<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_ARG_FIELDS"></a>
<h3>_ARG_FIELDS</h3>
A list of the fields that take arguments. Since Javadoc doesn't mark 
arguments in any special way, we must consult this list to decide whether 
the first word of a field is an argument or not.
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>list</code>

      </dd>
<span title="['group', 'variable', 'var', 'type', 'cvariable', 'cvar', 'ivariable', 'ivar', 'param', 'parameter', 'arg', 'argument', 'raise', 'raises', 'exception', 'except', 'deffield', 'newfield', 'keyword', 'kwarg', 'kwparam']">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
['group',
 'variable',
 'var',
 'type',
 'cvariable',
 'cvar',
 'ivariable',
 'ivar',
<span class="variable-ellipsis">...</span>                                                                    </pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_FIELD_RE"></a>
<h3>_FIELD_RE</h3>
A regular expression used to search for Javadoc block tags.
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>SRE_Pattern</code>

      </dd>
<span title="&lt;_sre.SRE_Pattern object at 0x8357368&gt;">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
<span class="re"><span class="re-group">(</span><span class="re-char">^</span><span class="re-char">\s</span><span class="re-op">*</span>@<span class="re-char">\w</span><span class="re-op">+</span><span class="re-group">[</span><span class="re-char">\s</span><span class="re-char">\$</span><span class="re-group">]</span><span class="re-group">)</span></span>                                                       </pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_LINK_SPLIT_RE"></a>
<h3>_LINK_SPLIT_RE</h3>
A regular expression used to search for Javadoc inline tags.
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>SRE_Pattern</code>

      </dd>
<span title="&lt;_sre.SRE_Pattern object at 0x83045e0&gt;">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
<span class="re"><span class="re-group">(</span><span class="re-char">\{</span>@link<span class="re-group">(?:</span>plain<span class="re-group">)</span><span class="re-op">?</span><span class="re-char">\s</span><span class="re-group">[^</span><span class="re-char">\}</span><span class="re-group">]</span><span class="re-op">+</span><span class="re-char">\}</span><span class="re-group">)</span></span>                                          </pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_LINK_RE"></a>
<h3>_LINK_RE</h3>
A regular expression used to process Javadoc inline tags.
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>SRE_Pattern</code>

      </dd>
<span title="&lt;_sre.SRE_Pattern object at 0x8440268&gt;">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
<span class="re"><span class="re-char">\{</span>@link<span class="re-group">(?:</span>plain<span class="re-group">)</span><span class="re-op">?</span><span class="re-char">\s</span><span class="re-op">+</span><span class="re-group">(</span><span class="re-group">[</span><span class="re-char">\w</span>#<span class="re-char">\.</span><span class="re-group">]</span><span class="re-op">+</span><span class="re-group">)</span><span class="re-group">(?:</span><span class="re-char">\(</span><span class="re-group">[^</span><span class="re-char">\)</span><span class="re-group">]</span><span class="re-op">*</span><span class="re-char">\)</span><span class="re-group">)</span><span class="re-op">?</span><span class="re-group">(</span><span class="re-char">\s</span><span class="re-op">+</span><span class="re-char">.</span><span class="re-op">*</span><span class="re-group">)</span><span class="re-op">?</span><span class="re-char">\}</span></span>                </pre>
        </td></tr></table></dd>
</span>    </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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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:14 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>