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
|
<?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.objdoc</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> ::
Module objdoc
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.objdoc-module.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.objdoc-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module epydoc.objdoc</h2>
<p>Support for <code>ObjDoc</code>s, which encode the information about a
Python object that is necessary to create its documentation.
<code>ObjDoc</code>s are created and managed by the <code>DocMap</code>
class, which acts like a dictionary from <a
href="epydoc.uid.UID-class.html" class="link"><code>UID</code></a>s to
<code>ObjDoc</code>s.</p>
<p>Textual documentation entries (e.g., module descriptions, method
descriptions, variable types, see-also entries) are encoded as <a
href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstrings</code></a>.</p>
Each Python object is identified by a globally unique identifier,
implemented with the <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a> class. These identifiers are also used
by the <code>Link</code> class to implement crossreferencing between
<code>ObjDoc</code>s.
<hr/>
<!-- =========== 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.objdoc.ClassDoc-class.html"><code>ClassDoc</code></a></b></td>
<td>The documentation for a class.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.DocField-class.html"><code>DocField</code></a></b></td>
<td>A generic docstring field.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.DocMap-class.html"><code>DocMap</code></a></b></td>
<td>A dictionary mapping each object to the object's documentation.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.FuncDoc-class.html"><code>FuncDoc</code></a></b></td>
<td>The documentation for a function.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.ModuleDoc-class.html"><code>ModuleDoc</code></a></b></td>
<td>The documentation for a module or package.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a></b></td>
<td>A base class for encoding the information about a Python object that
is necessary to create its documentation.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.Param-class.html"><code>Param</code></a></b></td>
<td>The documentation for a function parameter.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.PropertyDoc-class.html"><code>PropertyDoc</code></a></b></td>
<td>The documentation for a property.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.Raise-class.html"><code>Raise</code></a></b></td>
<td>The documentation for the raising of an exception.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.objdoc.Var-class.html"><code>Var</code></a></b></td>
<td>The documentation for a variable.</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"> </font></td>
<td><code><a name="report_param_mismatches"></a><span class="summary-sig"><span class="summary-sig-name">report_param_mismatches</span>(<span class=summary-sig-arg>docmap</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc-module.html#set_default_docformat" class="summary-sig-name"><code>set_default_docformat</code></a>(<span class=summary-sig-arg>new_format</span>)</span></code>
<br />
Change the default value for <code>__docformat__</code> to the given
value.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="epydoc.objdoc-module.html#DEFAULT_DOCFORMAT"><code>DEFAULT_DOCFORMAT</code></a></b>: The default value for <code>__docformat__</code>, if it is not
specified by modules.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="epydoc.objdoc-module.html#KNOWN_DOCFORMATS"><code>KNOWN_DOCFORMATS</code></a></b> = <span title="('plaintext', 'epytext', 'restructuredtext', 'javadoc')"><code>('plaintext', 'epytext', 'restructure<span class="variable-ellipsis">...</span></code>
</span></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="set_default_docformat"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">set_default_docformat</span>(<span class=sig-arg>new_format</span>)</span>
</h3>
Change the default value for <code>__docformat__</code> to the given
value. The current default value for <code>__docformat__</code> is
recorded in <code>DEFAULT_DOCFORMAT</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>new_format</b></code> -
The new default value for <code>__docformat__</code>
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
<p><b>See Also:</b> <a href="epydoc.objdoc-module.html#DEFAULT_DOCFORMAT"
class="link"><code>DEFAULT_DOCFORMAT</code></a>
</p>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="DEFAULT_DOCFORMAT"></a>
<h3>DEFAULT_DOCFORMAT</h3>
The default value for <code>__docformat__</code>, if it is not
specified by modules. <code>__docformat__</code> is a module variable
that specifies the markup language for the docstrings in a module. Its
value is a string, consisting the name of a markup language, optionally
followed by a language code (such as <code>en</code> for English). Some
typical values for <code>__docformat__</code> are:
<pre class="doctestblock">
<span class="py-src"><span class="py-prompt">>>> </span>__docformat__ = <span class="py-string">'plaintext'</span>
<span class="py-prompt">>>> </span>__docformat__ = <span class="py-string">'epytext'</span>
<span class="py-prompt">>>> </span>__docformat__ = <span class="py-string">'epytext en'</span></span></pre>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'plaintext'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>plaintext<span class="variable-quote">'</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="KNOWN_DOCFORMATS"></a>
<h3>KNOWN_DOCFORMATS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="('plaintext', 'epytext', 'restructuredtext', 'javadoc')"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
('plaintext', 'epytext', 'restructuredtext', 'javadoc') </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"> <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:19 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>
|
