buildframework/helium/doc/api_rst/antlib.rst.ftl
author marvin shi <marvin.shi@nokia.com>
Tue, 30 Nov 2010 17:14:57 +0800
changeset 714 e5a58c351011
parent 588 c7c26511138f
permissions -rw-r--r--
feature bsym format symbol rombuild support
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     1
<#--
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     2
============================================================================ 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     3
Name        : antlib.rst.ftl
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     4
Part of     : Helium 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     5
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     6
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     7
All rights reserved.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     8
This component and the accompanying materials are made available
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     9
under the terms of the License "Eclipse Public License v1.0"
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    10
which accompanies this distribution, and is available
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    11
at the URL "http://www.eclipse.org/legal/epl-v10.html".
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    12
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    13
Initial Contributors:
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    14
Nokia Corporation - initial contribution.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    15
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    16
Contributors:
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    17
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    18
Description:
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    19
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    20
============================================================================
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    21
-->
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    22
<#include "api.ftllib"/>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    23
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    24
<#list doc.antDatabase.antlib as antlib>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    25
<@pp.changeOutputFile name="antlib-${antlib.name}.rst" />
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    26
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    27
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    28
.. index::
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    29
   ${antlib.name}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    30
    
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    31
==========================================================
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    32
Antlib ${antlib.name}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    33
==========================================================
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    34
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    35
.. contents::
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    36
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    37
:Location: <@helium_api_location_path location="${antlib.location}"/>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    38
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    39
<#if antlib.macro?size &gt; 0>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    40
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    41
Macros
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    42
===========
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    43
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    44
<#assign macroCache = {}>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    45
<#list antlib.macro as macro>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    46
    <#assign macroCache = macroCache + {macro.name: macro}>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    47
</#list>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    48
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    49
<#list macroCache?keys?sort as name>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    50
<#assign macro=macroCache[name]>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    51
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    52
.. index::
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    53
   ${macro.name}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    54
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    55
${macro.name}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    56
----------------------------------------------------------
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    57
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    58
<#if macro.deprecated?length &gt; 0>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    59
..warning:: ${macro.deprecated}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    60
</#if>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    61
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    62
:Location: <@helium_api_location_path location="${macro.location}"/>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    63
:Scope: ${macro.scope}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    64
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    65
<#recurse macro.documentation>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    66
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    67
**Usage**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    68
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    69
::
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    70
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    71
    ${macro.usage?replace("^", "    ", "rm")}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    72
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    73
**Source code**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    74
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    75
::
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    76
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    77
    ${macro.source?replace("^", "    ", "rm")}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    78
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    79
</#list>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    80
</#if>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    81
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    82
</#list>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    83
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    84
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    85