|
1 |
|
2 |
|
3 |
|
4 <?xml version="1.0" encoding="utf-8"?> |
|
5 <!DOCTYPE HTML PUBLIC "-//w3c//dtd xhtml 1.0 strict//en" |
|
6 "http://www.w3.org/tr/xhtml1/dtd/xhtml1-strict.dtd"> |
|
7 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
8 |
|
9 |
|
10 <head> |
|
11 <meta name="keywords" content="helium"/> |
|
12 <meta http-equiv="content-type" content="text/html+xml; charset=iso-8859-1"/> |
|
13 <link rel="stylesheet" href="stylesheet.css" type="text/css" /> |
|
14 <script type="text/javascript"> |
|
15 var DOCUMENTATION_OPTIONS = { |
|
16 URL_ROOT: '', |
|
17 VERSION: '0' |
|
18 }; |
|
19 </script> |
|
20 <script type="text/javascript" src="../_static/jquery.js"></script> |
|
21 |
|
22 <script type="text/javascript" src="../_static/interface.js"></script> |
|
23 <script type="text/javascript" src="../_static/doctools.js"></script> |
|
24 |
|
25 <title>Helium API Help</title> |
|
26 </head> |
|
27 |
|
28 |
|
29 <body> |
|
30 <!-- ========= start of top navbar ======= --> |
|
31 <a name="navbar_top"><!-- --></a> |
|
32 <a href="#skip-navbar_top" title="skip navigation links"></a> |
|
33 <table border="0" width="100%" cellpadding="1" cellspacing="0" summary=""> |
|
34 <tr> |
|
35 <td colspan="2" bgcolor="#eeeeff" class="navbarcell1"> |
|
36 <a name="navbar_top_firstrow"><!-- --></a> |
|
37 <table border="0" cellpadding="0" cellspacing="3" summary=""> |
|
38 <tr align="center" valign="top"> |
|
39 <td bgcolor="#ffffff" class="navbarcell1">  <a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font> </a></td> |
|
40 |
|
41 <td bgcolor="#ffffff" class="navbarcell1"> <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a> </td> |
|
42 |
|
43 <td bgcolor="#eeeeff" class="navbarcell1"> <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a> </td> |
|
44 <td bgcolor="#eeeeff" class="navbarcell1"> <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a> </td> |
|
45 <td bgcolor="#eeeeff" class="navbarcell1"> <a href="help.html"><font class="navbarfont1"><b>help</b></font></a> </td> |
|
46 </tr> |
|
47 </table> |
|
48 </td> |
|
49 <td align="right" valign="top" rowspan="3"><em> |
|
50 <b>Helium API</b></em> |
|
51 |
|
52 </td> |
|
53 </tr> |
|
54 |
|
55 <tr> |
|
56 <td bgcolor="white" class="navbarcell2"><font size="-2"> |
|
57  prev  |
|
58  next</font></td> |
|
59 <td bgcolor="white" class="navbarcell2"><font size="-2"> |
|
60 <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>   |
|
61  <a href="overview-summary.html" target="_top"><b>no frames</b></a>   |
|
62 |
|
63  <script type="text/javascript"> |
|
64 <!-- |
|
65 if(window==top) { |
|
66 document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>'); |
|
67 } |
|
68 //--> |
|
69 </script> |
|
70 <noscript> |
|
71 <a href="allclasses-noframe.html"><b>all classes</b></a> |
|
72 </noscript> |
|
73 |
|
74 |
|
75 </font></td> |
|
76 </tr> |
|
77 </table> |
|
78 <a name="skip-navbar_top"></a> |
|
79 <!-- ========= end of top navbar ========= --> |
|
80 <hr/> |
|
81 |
|
82 <center> |
|
83 <h1> |
|
84 How This API Document Is Organized |
|
85 </h1> |
|
86 |
|
87 </center> |
|
88 |
|
89 This API document describes the Helium user API (Application Programming Interface) in terms of its Ant targets, properties and other configuration. It has pages corresponding to the items in the navigation bar, described as follows: |
|
90 |
|
91 <h3>Project</h3> |
|
92 |
|
93 A project corresponds to an Apache Ant XML file. Each project contains a number of targets. |
|
94 |
|
95 <h3>Target</h3> |
|
96 |
|
97 Each target has its own page listing the following sections: |
|
98 <ul> |
|
99 <li>Location</li> |
|
100 <li>Description</li> |
|
101 <li>Property dependencies. A list of Ant properties that this target uses and their edit status requirements.</li> |
|
102 <li>Target dependencies. A list of other targets that will be called before or during this target execution.</li> |
|
103 </ul> |
|
104 |
|
105 Target dependencies legend: |
|
106 <ul> |
|
107 <li>Blue arrows point to direct dependencies.</li> |
|
108 <li>Green arrows point to antcall and runtarget dependencies.</li> |
|
109 </ul> |
|
110 |
|
111 <p align="center"> |
|
112 <img src="target-example.dot.png" usemap="#target-example" |
|
113 style="border-style: none"/> |
|
114 <map name="target-example" id="target-example"> |
|
115 </map> |
|
116 </p> |
|
117 |
|
118 <h3>Property Group</h3> |
|
119 A list of Property groups that group together related configuration elements, their usage requirements within that group and their edit status requirements.. |
|
120 |
|
121 <h3>Property</h3> |
|
122 Each property has its own page listing the following sections: |
|
123 <ul> |
|
124 <li>Description</li> |
|
125 <li>Usage</li> |
|
126 <li>Type</li> |
|
127 <li>Edit Status : The values could be must, recommended, allowed, discouraged or never.</li> |
|
128 </ul> |
|
129 <h3></h3> |
|
130 <h3></h3> |
|
131 |
|
132 |
|
133 <hr/> |
|
134 <!-- ========= start of top navbar ======= --> |
|
135 <a name="navbar_top"><!-- --></a> |
|
136 <a href="#skip-navbar_top" title="skip navigation links"></a> |
|
137 <table border="0" width="100%" cellpadding="1" cellspacing="0" summary=""> |
|
138 <tr> |
|
139 <td colspan="2" bgcolor="#eeeeff" class="navbarcell1"> |
|
140 <a name="navbar_top_firstrow"><!-- --></a> |
|
141 <table border="0" cellpadding="0" cellspacing="3" summary=""> |
|
142 <tr align="center" valign="top"> |
|
143 <td bgcolor="#ffffff" class="navbarcell1">  <a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font> </a></td> |
|
144 |
|
145 <td bgcolor="#ffffff" class="navbarcell1"> <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a> </td> |
|
146 |
|
147 <td bgcolor="#eeeeff" class="navbarcell1"> <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a> </td> |
|
148 <td bgcolor="#eeeeff" class="navbarcell1"> <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a> </td> |
|
149 <td bgcolor="#eeeeff" class="navbarcell1"> <a href="help.html"><font class="navbarfont1"><b>help</b></font></a> </td> |
|
150 </tr> |
|
151 </table> |
|
152 </td> |
|
153 <td align="right" valign="top" rowspan="3"><em> |
|
154 <b>Helium API</b></em> |
|
155 |
|
156 </td> |
|
157 </tr> |
|
158 |
|
159 <tr> |
|
160 <td bgcolor="white" class="navbarcell2"><font size="-2"> |
|
161  prev  |
|
162  next</font></td> |
|
163 <td bgcolor="white" class="navbarcell2"><font size="-2"> |
|
164 <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>   |
|
165  <a href="overview-summary.html" target="_top"><b>no frames</b></a>   |
|
166 |
|
167  <script type="text/javascript"> |
|
168 <!-- |
|
169 if(window==top) { |
|
170 document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>'); |
|
171 } |
|
172 //--> |
|
173 </script> |
|
174 <noscript> |
|
175 <a href="allclasses-noframe.html"><b>all classes</b></a> |
|
176 </noscript> |
|
177 |
|
178 |
|
179 </font></td> |
|
180 </tr> |
|
181 </table> |
|
182 <a name="skip-navbar_top"></a> |
|
183 <!-- ========= end of top navbar ========= --> |
|
184 <font size="-2">Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: http://www.eclipse.org/legal/epl-v10.html</font> |
|
185 </body> |
|
186 |
|
187 </html> |
|
188 |