Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / a1cdd89614292d9758aeb97acf8b9ae1cf4526a3 / . / TestON / Documentation / TestON_Document / help.html
blob: cd9a3b9547f05bef7f36f8ba986d0f3935c28bc2 [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>Help</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th bgcolor="#70b0f0" class="navbar-select"
31 >&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th>
32
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">&nbsp;</td>
44 <td>
45 <table cellpadding="0" cellspacing="0">
46 <!-- hide/show private -->
47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49 <tr><td align="right"><span class="options"
50 >[<a href="frames.html" target="_top">frames</a
51 >]&nbsp;|&nbsp;<a href="help.html"
52 target="_top">no&nbsp;frames</a>]</span></td></tr>
53 </table>
54 </td>
55 </tr>
56</table>
57
58<h1 class="epydoc"> API Documentation </h1>
59
60<p> This document contains the API (Application Programming Interface)
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]61documentation for TestON. Documentation for the Python
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]62objects defined by the project is divided into separate pages for each
63package, module, and class. The API documentation also includes two
64pages containing information about the project as a whole: a trees
65page, and an index page. </p>
66
67<h2> Object Documentation </h2>
68
69 <p>Each <strong>Package Documentation</strong> page contains: </p>
70 <ul>
71 <li> A description of the package. </li>
72 <li> A list of the modules and sub-packages contained by the
73 package. </li>
74 <li> A summary of the classes defined by the package. </li>
75 <li> A summary of the functions defined by the package. </li>
76 <li> A summary of the variables defined by the package. </li>
77 <li> A detailed description of each function defined by the
78 package. </li>
79 <li> A detailed description of each variable defined by the
80 package. </li>
81 </ul>
82
83 <p>Each <strong>Module Documentation</strong> page contains:</p>
84 <ul>
85 <li> A description of the module. </li>
86 <li> A summary of the classes defined by the module. </li>
87 <li> A summary of the functions defined by the module. </li>
88 <li> A summary of the variables defined by the module. </li>
89 <li> A detailed description of each function defined by the
90 module. </li>
91 <li> A detailed description of each variable defined by the
92 module. </li>
93 </ul>
94
95 <p>Each <strong>Class Documentation</strong> page contains: </p>
96 <ul>
97 <li> A class inheritance diagram. </li>
98 <li> A list of known subclasses. </li>
99 <li> A description of the class. </li>
100 <li> A summary of the methods defined by the class. </li>
101 <li> A summary of the instance variables defined by the class. </li>
102 <li> A summary of the class (static) variables defined by the
103 class. </li>
104 <li> A detailed description of each method defined by the
105 class. </li>
106 <li> A detailed description of each instance variable defined by the
107 class. </li>
108 <li> A detailed description of each class (static) variable defined
109 by the class. </li>
110 </ul>
111
112<h2> Project Documentation </h2>
113
114 <p> The <strong>Trees</strong> page contains the module and class hierarchies: </p>
115 <ul>
116 <li> The <em>module hierarchy</em> lists every package and module, with
117 modules grouped into packages. At the top level, and within each
118 package, modules and sub-packages are listed alphabetically. </li>
119 <li> The <em>class hierarchy</em> lists every class, grouped by base
120 class. If a class has more than one base class, then it will be
121 listed under each base class. At the top level, and under each base
122 class, classes are listed alphabetically. </li>
123 </ul>
124
125 <p> The <strong>Index</strong> page contains indices of terms and
126 identifiers: </p>
127 <ul>
128 <li> The <em>term index</em> lists every term indexed by any object's
129 documentation. For each term, the index provides links to each
130 place where the term is indexed. </li>
131 <li> The <em>identifier index</em> lists the (short) name of every package,
132 module, class, method, function, variable, and parameter. For each
133 identifier, the index provides a short description, and a link to
134 its documentation. </li>
135 </ul>
136
137<h2> The Table of Contents </h2>
138
139<p> The table of contents occupies the two frames on the left side of
140the window. The upper-left frame displays the <em>project
141contents</em>, and the lower-left frame displays the <em>module
142contents</em>: </p>
143
144<table class="help summary" border="1" cellspacing="0" cellpadding="3">
145 <tr style="height: 30%">
146 <td align="center" style="font-size: small">
147 Project<br />Contents<hr />...</td>
148 <td align="center" style="font-size: small" rowspan="2" width="70%">
149 API<br />Documentation<br />Frame<br /><br /><br />
150 </td>
151 </tr>
152 <tr>
153 <td align="center" style="font-size: small">
154 Module<br />Contents<hr />&nbsp;<br />...<br />&nbsp;
155 </td>
156 </tr>
157</table><br />
158
159<p> The <strong>project contents frame</strong> contains a list of all packages
160and modules that are defined by the project. Clicking on an entry
161will display its contents in the module contents frame. Clicking on a
162special entry, labeled "Everything," will display the contents of
163the entire project. </p>
164
165<p> The <strong>module contents frame</strong> contains a list of every
166submodule, class, type, exception, function, and variable defined by a
167module or package. Clicking on an entry will display its
168documentation in the API documentation frame. Clicking on the name of
169the module, at the top of the frame, will display the documentation
170for the module itself. </p>
171
172<p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top
173navigation bar can be used to control whether the table of contents is
174displayed or not. </p>
175
176<h2> The Navigation Bar </h2>
177
178<p> A navigation bar is located at the top and bottom of every page.
179It indicates what type of page you are currently viewing, and allows
180you to go to related pages. The following table describes the labels
181on the navigation bar. Note that not some labels (such as
182[Parent]) are not displayed on all pages. </p>
183
184<table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%">
185<tr class="summary">
186 <th>Label</th>
187 <th>Highlighted when...</th>
188 <th>Links to...</th>
189</tr>
190 <tr><td valign="top"><strong>[Parent]</strong></td>
191 <td valign="top"><em>(never highlighted)</em></td>
192 <td valign="top"> the parent of the current package </td></tr>
193 <tr><td valign="top"><strong>[Package]</strong></td>
194 <td valign="top">viewing a package</td>
195 <td valign="top">the package containing the current object
196 </td></tr>
197 <tr><td valign="top"><strong>[Module]</strong></td>
198 <td valign="top">viewing a module</td>
199 <td valign="top">the module containing the current object
200 </td></tr>
201 <tr><td valign="top"><strong>[Class]</strong></td>
202 <td valign="top">viewing a class </td>
203 <td valign="top">the class containing the current object</td></tr>
204 <tr><td valign="top"><strong>[Trees]</strong></td>
205 <td valign="top">viewing the trees page</td>
206 <td valign="top"> the trees page </td></tr>
207 <tr><td valign="top"><strong>[Index]</strong></td>
208 <td valign="top">viewing the index page</td>
209 <td valign="top"> the index page </td></tr>
210 <tr><td valign="top"><strong>[Help]</strong></td>
211 <td valign="top">viewing the help page</td>
212 <td valign="top"> the help page </td></tr>
213</table>
214
215<p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below
216the top navigation bar can be used to control whether documentation
217for private objects is displayed. Private objects are usually defined
218as objects whose (short) names begin with a single underscore, but do
219not end with an underscore. For example, "<code>_x</code>",
220"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"
221are private objects; but "<code>re.sub</code>",
222"<code>__init__</code>", and "<code>type_</code>" are not. However,
223if a module defines the "<code>__all__</code>" variable, then its
224contents are used to decide which objects are private. </p>
225
226<p> A timestamp below the bottom navigation bar indicates when each
227page was last updated. </p>
228<!-- ==================== NAVIGATION BAR ==================== -->
229<table class="navbar" border="0" width="100%" cellpadding="0"
230 bgcolor="#a0c0ff" cellspacing="0">
231 <tr valign="middle">
232 <!-- Home link -->
233 <th>&nbsp;&nbsp;&nbsp;<a
234 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
235
236 <!-- Tree link -->
237 <th>&nbsp;&nbsp;&nbsp;<a
238 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
239
240 <!-- Index link -->
241 <th>&nbsp;&nbsp;&nbsp;<a
242 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
243
244 <!-- Help link -->
245 <th bgcolor="#70b0f0" class="navbar-select"
246 >&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th>
247
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]248 <!-- Project homepage -->
249 <th class="navbar" align="right" width="100%">
250 <table border="0" cellpadding="0" cellspacing="0">
251 <tr><th class="navbar" align="center"
252 >TestON</th>
253 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]254 </tr>
255</table>
256<table border="0" cellpadding="0" cellspacing="0" width="100%%">
257 <tr>
258 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]259 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:34 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]260 </td>
261 <td align="right" class="footer">
262 <a target="mainFrame" href="http://epydoc.sourceforge.net"
263 >http://epydoc.sourceforge.net</a>
264 </td>
265 </tr>
266</table>
267
268<script type="text/javascript">
269 <!--
270 // Private objects are initially displayed (because if
271 // javascript is turned off then we want them to be
272 // visible); but by default, we want to hide them. So hide
273 // them unless we have a cookie that says to show them.
274 checkCookie();
275 // -->
276</script>
277</body>
278</html>