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

<h1 class="epydoc">Module javadoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.javadoc-pysrc.html">source code</a></span></p>

<p>Epydoc parser for <a href="http://java.sun.com/j2se/javadoc/"

target="_top">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:</p>

<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>{@<i

class="math">tag</i> <i class="math">[args...]</i>}</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>

<p>Epydoc supports all Javadoc tags, <i>except</i>:</p>

<ul>

<li>

<code>{@docRoot}</code>, which gives the (relative) URL of the

generated documentation's root.

</li>

<li>

100

<code>{@inheritDoc}</code>, which copies the documentation of the

101

nearest overridden object. This can be used to combine the

102

documentation of the overridden object with the documentation of the

103

overridding object.

104

</li>

105

<li>

106

<code>@serial</code>, <code>@serialField</code>, and

107

<code>@serialData</code> which describe the serialization (pickling)

108

of an object.

109

</li>

110

<li>

111

<code>{@value}</code>, which copies the value of a constant.

112

</li>

113

</ul>

114

115

<hr />

116

<div class="fields"> <p><strong>Warning:</strong>

117

Epydoc only supports HTML output for Javadoc docstrings.

118

</p>

119

</div>

120

121

<table class="summary" border="1" cellpadding="3"

122

cellspacing="0" width="100%" bgcolor="white">

123

124

125

126

127

<td align="left"><span class="table-header">Classes</span></td>

128

<td align="right" valign="top"

129

><span class="options">[<a href="#section-Classes"

130

class="privatelink" onclick="toggle_private();"

131

>hide private</a>]</span></td>

132

</tr>

133

</table>

134

</td>

135

</tr>

136

<tr>

137

138

139

</td><td class="summary">

140

<a href="epydoc.markup.javadoc.ParsedJavadocDocstring-class.html" class="summary-name">ParsedJavadocDocstring</a><br />

141

An encoded version of a Javadoc docstring.

142

</td>

143

</tr>

144

</table>

145

146

147

<table class="summary" border="1" cellpadding="3"

148

cellspacing="0" width="100%" bgcolor="white">

149

150

151

152

153

<td align="left"><span class="table-header">Functions</span></td>

154

<td align="right" valign="top"

155

><span class="options">[<a href="#section-Functions"

156

class="privatelink" onclick="toggle_private();"

157

>hide private</a>]</span></td>

158

</tr>

159

</table>

160

</td>

161

</tr>

162

<tr>

163

164

<span class="summary-type"><a href="epydoc.markup.ParsedDocstring-class.html"

165

class="link">ParsedDocstring</a></span>

166

</td><td class="summary">

167

168

<tr>

169

<td><span class="summary-sig"><a href="epydoc.markup.javadoc-module.html#parse_docstring" class="summary-sig-name">parse_docstring</a>(<span class="summary-sig-arg">docstring</span>,

170

<span class="summary-sig-arg">errors</span>,

171

<span class="summary-sig-arg">**options</span>)</span><br />

172

Parse the given docstring, which is formatted using Javadoc; and

173

return a <code>ParsedDocstring</code> representation of its contents.</td>

174

175

<span class="codelink"><a href="epydoc.markup.javadoc-pysrc.html#parse_docstring">source code</a></span>

176

177

</td>

178

</tr>

179

</table>

180

181

</td>

182

</tr>

183

</table>

184

185

186

<table class="details" border="1" cellpadding="3"

187

cellspacing="0" width="100%" bgcolor="white">

188

189

190

191

192

<td align="left"><span class="table-header">Function Details</span></td>

193

<td align="right" valign="top"

194

><span class="options">[<a href="#section-FunctionDetails"

195

class="privatelink" onclick="toggle_private();"

196

>hide private</a>]</span></td>

197

</tr>

198

</table>

199

</td>

200

</tr>

201

</table>

202

203

<div>

204

<table class="details" border="1" cellpadding="3"

205

cellspacing="0" width="100%" bgcolor="white">

206

207

208

209

<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_docstring</span>(<span class="sig-arg">docstring</span>,

210

<span class="sig-arg">errors</span>,

211

<span class="sig-arg">**options</span>)</span>

212

</h3>

213

</td><td align="right" valign="top"

214

><span class="codelink"><a href="epydoc.markup.javadoc-pysrc.html#parse_docstring">source code</a></span> 

215

</td>

216

</tr></table>

217

218

<p>Parse the given docstring, which is formatted using Javadoc; and

219

return a <code>ParsedDocstring</code> representation of its contents.</p>

220

221

<dt>Parameters:</dt>

222

223

<li><strong class="pname"><code>docstring</code></strong> (<code>string</code>) - The docstring to parse</li>

224

<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <a

225

href="epydoc.markup.ParseError-class.html"

226

class="link">ParseError</a>) - A list where any errors generated during parsing will be stored.</li>

227

<li><strong class="pname"><code>options</code></strong> - Extra options. Unknown options are ignored. Currently, no extra

228

options are defined.</li>

229

</ul></dd>

230

<dt>Returns: <a href="epydoc.markup.ParsedDocstring-class.html"

231

class="link">ParsedDocstring</a></dt>

232

</dl>

233

</td></tr></table>

234

</div>

235

<br />

236

237

<table class="navbar" border="0" width="100%" cellpadding="0"

238

bgcolor="#a0c0ff" cellspacing="0">

239

240

241

<th>   <a

242

href="epydoc-module.html">Home</a>   </th>

243

244

245

<th>   <a

246

href="module-tree.html">Trees</a>   </th>

247

248

249

<th>   <a

250

href="identifier-index.html">Indices</a>   </th>

251

252

253

<th>   <a

254

href="help.html">Help</a>   </th>

255

256

257

258

259

<tr><th class="navbar" align="center"

260

><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>

261

</tr></table></th>

262

</tr>

263

</table>

264

265

<tr>

266

267

<a href="epydoc-log.html">Generated by Epydoc

268

3.0.1 on Wed Jan 30 14:06:45 2008</a>

269

</td>

270

271

<a target="mainFrame" href="http://epydoc.sourceforge.net"

272

>http://epydoc.sourceforge.net</a>

273

</td>

274

</tr>

275

</table>

276

277

278

<!--

279

// Private objects are initially displayed (because if

280

// javascript is turned off then we want them to be

281

// visible); but by default, we want to hide them. So hide

282

// them unless we have a cookie that says to show them.

283

checkCookie();

284

// -->

285

</script>

286

</body>

287

</html>

Older »