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
|
<?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</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> ::
Module javadoc
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/epydoc.markup.javadoc-module.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.markup.javadoc-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module epydoc.markup.javadoc</h2>
Epydoc parser for <a
href="http://java.sun.com/j2se/javadoc/">Javadoc</a> docstrings. Javadoc
is an HTML-based markup language that was developed for documenting Java
APIs with inline comments. It consists of raw HTML, augmented by Javadoc
tags. There are two types of Javadoc tag:
<ul>
<li>
<a name="index-Javadoc_block_tags"></a><i
class="indexterm">Javadoc block tags</i> correspond to Epydoc fields.
They are marked by starting a line with a string of the form
"<code>@<i class="math">tag</i> [<i
class="math">arg</i>]</code>", where <code><i
class="math">tag</i></code> indicates the type of block, and <code><i
class="math">arg</i></code> is an optional argument. (For fields that
take arguments, Javadoc assumes that the single word immediately
following the tag is an argument; multi-word arguments cannot be used
with javadoc.)
</li>
<li>
<a name="index-inline_Javadoc_tags"></a><i
class="indexterm">inline Javadoc tags</i> are used for inline markup.
In particular, epydoc uses them for crossreference links between
documentation. Inline tags may appear anywhere in the text, and have
the form "<code>{@ }</code>", where <code><i
class="math">tag</i></code> indicates the type of inline markup, and
<code><i class="math">args</i></code> are optional arguments.
</li>
</ul>
Epydoc supports all Javadoc tags, <i>except</i>:
<ul>
<li>
<code>{@docRoot}</code>, which gives the (relative) URL of the
generated documentation's root.
</li>
<li>
<code>{@inheritDoc}</code>, which copies the documentation of
the nearest overridden object. This can be used to combine the
documentation of the overridden object with the documentation of the
overridding object.
</li>
<li>
<code>@serial</code>, <code>@serialField</code>, and
<code>@serialData</code> which describe the serialization
(pickling) of an object.
</li>
<li>
<code>{@value}</code>, which copies the value of a
constant.
</li>
</ul>
<hr/>
<p><b>Warning:</b> Epydoc only supports HTML output for Javadoc docstrings.
</p>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.javadoc.ParsedJavadocDocstring-class.html"><code>ParsedJavadocDocstring</code></a></b></td>
<td>An encoded version of a Javadoc docstring.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></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-module.html#parse_docstring" class="summary-sig-name"><code>parse_docstring</code></a>(<span class=summary-sig-arg>docstring</span>,
<span class=summary-sig-arg>errors</span>,
<span class="summary-sig-kwarg">**options</span>)</span></code>
<br />
Parse the given docstring, which is formatted using Javadoc; and
return a <code>ParsedDocstring</code> representation of its contents.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="parse_docstring"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse_docstring</span>(<span class=sig-arg>docstring</span>,
<span class=sig-arg>errors</span>,
<span class="sig-kwarg">**options</span>)</span>
</h3>
Parse the given docstring, which is formatted using Javadoc; and
return a <code>ParsedDocstring</code> representation of its
contents.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>docstring</b></code> -
The docstring to parse
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>errors</b></code> -
A list where any errors generated during parsing will be
stored.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
<dd><code><b>options</b></code> -
Extra options. Unknown options are ignored. Currently, no
extra options are defined.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>
</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: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>
|
