~ubuntu-branches/ubuntu/trusty/pyinotify/trusty-proposed

<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 pyinotify. 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

100

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

101

class, classes are listed alphabetically. </li>

102

</ul></p>

103

104

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

105

identifiers:

106

<ul>

107

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

108

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

109

place where the term is indexed. </li>

110

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

111

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

112

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

113

its documentation. </li>

114

</ul></p>

115

116

<h2> The Table of Contents </h2>

117

118

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

119

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

120

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

121

contents</i>: </p>

122

123

124

125

126

127

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

128

129

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

130

</td>

131

</tr>

132

<tr>

133

134

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

135

</td>

136

</tr>

137

</table><br>

138

</center>

139

140

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

141

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

142

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

143

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

144

the entire project. </p>

145

146

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

147

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

148

module or package. Clicking on an entry will display its

149

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

150

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

151

for the module itself. </p>

152

153

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

154

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

155

displayed or not. </p>

156

157

<h2> The Navigation Bar </h2>

158

159

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

160

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

161

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

162

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

163

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

164

165

166

167

<th>Label</th>

168

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

169

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

170

</tr>

171

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

172

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

173

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

174

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

175

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

176

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

177

</td></tr>

178

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

179

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

180

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

181

</td></tr>

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

192

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

193

194

</table>

195

196

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

197

the top navigation bar can be used to control whether documentation

198

for private objects is displayed. Private objects are usually defined

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

207

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

208

page was last updated. </p>

209

210

211

212

213

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

214

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

215

216

217

218

219

220

pyinotify

221

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

222

</th>

223

</tr>

224

</table>

225

226

227

<tr>

228

<td align="left"><font size="-2">Generated by Epydoc 2.1 on Wed Mar 29 03:46:07 2006</font></td>

229

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

230

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

231

</tr>

232

</table>

233

</body>

234

</html>

Older »