diff -r 044383f39525 -r be27ed110b50 buildframework/helium/doc/src/api/help.html.ftl --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/buildframework/helium/doc/src/api/help.html.ftl Wed Oct 28 14:39:48 2009 +0000 @@ -0,0 +1,78 @@ +<#-- +============================================================================ +Name : +Part of : Helium + +Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). +All rights reserved. +This component and the accompanying materials are made available +under the terms of the License "Eclipse Public License v1.0" +which accompanies this distribution, and is available +at the URL "http://www.eclipse.org/legal/epl-v10.html". + +Initial Contributors: +Nokia Corporation - initial contribution. + +Contributors: + +Description: + +============================================================================ +--> +<#include "api.ftllib"/> + +<@helium_api_header title="Helium API Help"/> + +
+

+ How This API Document Is Organized +

+ +
+ + 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: + +

Project

+ + A project corresponds to an Apache Ant XML file. Each project contains a number of targets. + +

Target

+ + Each target has its own page listing the following sections: + + + Target dependencies legend: + + +

+ + + <#include "target-example.dot.cmap"/> + +

+ +

Property Group

+ A list of Property groups that group together related configuration elements, their usage requirements within that group and their edit status requirements.. + +

Property

+ Each property has its own page listing the following sections: + +

+

+ + +<@helium_api_html_footer/> \ No newline at end of file