|
1 <#-- |
|
2 ============================================================================ |
|
3 Name : |
|
4 Part of : Helium |
|
5 |
|
6 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
7 All rights reserved. |
|
8 This component and the accompanying materials are made available |
|
9 under the terms of the License "Eclipse Public License v1.0" |
|
10 which accompanies this distribution, and is available |
|
11 at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
12 |
|
13 Initial Contributors: |
|
14 Nokia Corporation - initial contribution. |
|
15 |
|
16 Contributors: |
|
17 |
|
18 Description: |
|
19 |
|
20 ============================================================================ |
|
21 --> |
|
22 <#include "api.ftllib"/> |
|
23 |
|
24 <@helium_api_header title="Helium API"/> |
|
25 |
|
26 |
|
27 <center> |
|
28 <h1>Helium API</h1> |
|
29 </center> |
|
30 |
|
31 <p> |
|
32 This is the API specification for the Helium build toolkit. |
|
33 </p> |
|
34 |
|
35 <ul> |
|
36 <li><a href="#projects">Projects</a></li> |
|
37 <li><a href="#propertygroups">Property groups</a></li> |
|
38 </ul> |
|
39 |
|
40 <h2><a name="projects">Projects</a></h2> |
|
41 <p> |
|
42 Helium is configured into a set of Ant project files that group related functionality. |
|
43 </p> |
|
44 <table class="docutils"> |
|
45 <tr> |
|
46 <th class="head">Project name</th> |
|
47 <th class="head">Description</th> |
|
48 </tr> |
|
49 <#assign projectInfo = {}> |
|
50 <#list doc.antDatabase.project as project> |
|
51 <#assign projectInfo = projectInfo + {project.name: project.documentation}> |
|
52 </#list> |
|
53 <#list projectInfo?keys?sort as name> |
|
54 <tr> |
|
55 <td><a href="project-${name}.html" target="classframe">${name}</a></td> |
|
56 <td><#recurse projectInfo[name]></td> |
|
57 </tr> |
|
58 </#list> |
|
59 </table> |
|
60 <br/> |
|
61 |
|
62 <h2><a name="propertygroups">Property groups</a></h2> |
|
63 <p> |
|
64 Property groups define a set of properties that relate to a specific feature or functionality in Helium. |
|
65 </p> |
|
66 <table class="docutils"> |
|
67 <tr> |
|
68 <th class="head">Property group name</th> |
|
69 <th class="head">Description</th> |
|
70 </tr> |
|
71 <#list data.heliumDataModel.group as group> |
|
72 <tr> |
|
73 <td><a href="propertygroup-${group.name}.html" target="classframe">${group.name}</a></td> |
|
74 <td>${group.description}</td> |
|
75 </tr> |
|
76 </#list> |
|
77 </table> |
|
78 |
|
79 <@helium_api_html_footer/> |