~spiv/ubuntu/lucid/paramiko/address-families-579530-lucid

<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="help.html" target="_top">no frames</a>]</font></td></tr>

</table></td>

</tr></table>

<center><h2> API Documentation </h2></center>

<p> This document contains the API (Application Programming Interface)

documentation for this project. Documentation for the Python

objects defined by the project is divided into separate pages for each

package, module, and class. The API documentation also includes two

pages containing information about the project as a whole: a trees

page, and an index page. </p>

<h2> Object Documentation </h2>

<p>Each <b>Package Documentation</b> page contains:

<ul>

<li> A description of the package. </li>

<li> A list of the modules and sub-packages contained by the

package. </li>

<li> A summary of the classes defined by the package. </li>

<li> A summary of the functions defined by the package. </li>

<li> A summary of the variables defined by the package. </li>

<li> A detailed description of each function defined by the

package. </li>

<li> A detailed description of each variable defined by the

package. </li>

</ul></p>

<p>Each <b>Module Documentation</b> page contains:

<ul>

<li> A description of the module. </li>

<li> A summary of the classes defined by the module. </li>

<li> A summary of the functions defined by the module. </li>

<li> A summary of the variables defined by the module. </li>

<li> A detailed description of each function defined by the

module. </li>

<li> A detailed description of each variable defined by the

module. </li>

</ul></p>

<p>Each <b>Class Documentation</b> page contains:

<ul>

<li> A class inheritance diagram. </li>

<li> A list of known subclasses. </li>

<li> A description of the class. </li>

<li> A summary of the methods defined by the class. </li>

<li> A summary of the instance variables defined by the class. </li>

<li> A summary of the class (static) variables defined by the

class. </li>

<li> A detailed description of each method defined by the

class. </li>

<li> A detailed description of each instance variable defined by the

class. </li>

<li> A detailed description of each class (static) variable defined

by the class. </li>

</ul></p>

<h2> Project Documentation </h2>

<p> The <b>Trees</b> page contains the module and class hierarchies:

<ul>

<li> The <i>module hierarchy</i> lists every package and module, with

modules grouped into packages. At the top level, and within each

package, modules and sub-packages are listed alphabetically. </li>

<li> The <i>class hierarchy</i> lists every class, grouped by base

class. If a class has more than one base class, then it will be

listed under each base class. At the top level, and under each base

class, classes are listed alphabetically. </li>

</ul></p>

<p> The <b>Index</b> page contains indices of terms and

100

identifiers:

101

<ul>

102

<li> The <i>term index</i> lists every term indexed by any object's

103

documentation. For each term, the index provides links to each

104

place where the term is indexed. </li>

105

<li> The <i>identifier index</i> lists the (short) name of every package,

106

module, class, method, function, variable, and parameter. For each

107

identifier, the index provides a short description, and a link to

108

its documentation. </li>

109

</ul></p>

110

111

<h2> The Table of Contents </h2>

112

113

<p> The table of contents occupies the two frames on the left side of

114

the window. The upper-left frame displays the <i>project

115

contents</i>, and the lower-left frame displays the <i>module

116

contents</i>: </p>

117

118

119

120

121

122

<font size="-1">Project<br>Contents<hr>...</font></td>

123

124

API<br>Documentation<br>Frame<br><br><br>

125

</td>

126

</tr>

127

<tr>

128

129

<font size="-1">Module<br>Contents<hr> <br>...<br> </font>

130

</td>

131

</tr>

132

</table><br>

133

</center>

134

135

<p> The <b>project contents frame</b> contains a list of all packages

136

and modules that are defined by the project. Clicking on an entry

137

will display its contents in the module contents frame. Clicking on a

138

special entry, labeled "Everything," will display the contents of

139

the entire project. </p>

140

141

<p> The <b>module contents frame</b> contains a list of every

142

submodule, class, type, exception, function, and variable defined by a

143

module or package. Clicking on an entry will display its

144

documentation in the API documentation frame. Clicking on the name of

145

the module, at the top of the frame, will display the documentation

146

for the module itself. </p>

147

148

<p> The "<b>frames</b>" and "<b>no frames</b>" buttons below the top

149

navigation bar can be used to control whether the table of contents is

150

displayed or not. </p>

151

152

<h2> The Navigation Bar </h2>

153

154

<p> A navigation bar is located at the top and bottom of every page.

155

It indicates what type of page you are currently viewing, and allows

156

you to go to related pages. The following table describes the labels

157

on the navigation bar. Note that not some labels (such as

158

[Parent]) are not displayed on all pages. </p>

159

160

161

162

<th>Label</th>

163

<th>Highlighted when...</th>

164

<th>Links to...</th>

165

</tr>

166

<tr><td valign="top"><b>[Parent]</b></td>

167

<td valign="top"><i>(never highlighted)</i></td>

168

<td valign="top"> the parent of the current package </td></tr>

169

<tr><td valign="top"><b>[Package]</b></td>

170

<td valign="top">viewing a package</td>

171

<td valign="top">the package containing the current object

172

</td></tr>

173

<tr><td valign="top"><b>[Module]</b></td>

174

<td valign="top">viewing a module</td>

175

<td valign="top">the module containing the current object

176

</td></tr>

177

<tr><td valign="top"><b>[Class]</b></td>

178

<td valign="top">viewing a class </td>

179

<td valign="top">the class containing the current object</td></tr>

180

<tr><td valign="top"><b>[Trees]</b></td>

181

<td valign="top">viewing the trees page</td>

182

<td valign="top"> the trees page </td></tr>

183

<tr><td valign="top"><b>[Index]</b></td>

184

<td valign="top">viewing the index page</td>

185

<td valign="top"> the index page </td></tr>

186

187

<td valign="top">viewing the help page</td>

188

189

</table>

190

191

<p> The "<b>show private</b>" and "<b>hide private</b>" buttons below

192

the top navigation bar can be used to control whether documentation

193

for private objects is displayed. Private objects are usually defined

194

as objects whose (short) names begin with a single underscore, but do

195

not end with an underscore. For example, "<code>_x</code>",

196

"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"

197

are private objects; but "<code>re.sub</code>",

198

"<code>__init__</code>", and "<code>type_</code>" are not. However,

199

if a module defines the "<code>__all__</code>" variable, then its

200

contents are used to decide which objects are private. </p>

201

202

<p> A timestamp below the bottom navigation bar indicates when each

203

page was last updated. </p>

204

205

206

207

208

209

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

210

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

211

212

213

</tr>

214

</table>

215

216

217

<tr>

218

<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</font></td>

219

<td align="right"><a href="http://epydoc.sourceforge.net"

220

><font size="-2">http://epydoc.sf.net</font></a></td>

221

</tr>

222

</table>

223

</body>

224

</html>

Older »