buildframework/helium/doc/src/api/property.html.ftl
author timothy.murphy@nokia.com
Mon, 10 May 2010 16:46:16 +0100
branchfix
changeset 542 80c21f026f0a
parent 217 0f5e3a7fb6af
permissions -rw-r--r--
fix: switch rfi file creation back on
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     1
<#--
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     2
============================================================================ 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     3
Name        : 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     4
Part of     : Helium 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     5
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     6
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     7
All rights reserved.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     8
This component and the accompanying materials are made available
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     9
under the terms of the License "Eclipse Public License v1.0"
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    10
which accompanies this distribution, and is available
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    11
at the URL "http://www.eclipse.org/legal/epl-v10.html".
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    12
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    13
Initial Contributors:
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    14
Nokia Corporation - initial contribution.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    15
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    16
Contributors:
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    17
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    18
Description:
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    19
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    20
============================================================================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    21
-->
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    22
<#include "api.ftllib"/>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    23
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    24
<#list doc.antDatabase.project.property as property>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    25
<@pp.changeOutputFile name="property-${property.name}.html" />
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    26
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    27
<@helium_api_header title="property ${property.name}"/>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    28
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    29
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    30
    
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    31
<h2>Property ${property.name}</h2>
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    32
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    33
<b>Type: </b>${property.type}<br/>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    34
<b>Scope: </b>${property.scope}<br/>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    35
<b>Editable: </b>${property.editable}<br/>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    36
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    37
<b>Default value: </b>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    38
<#assign defaultValue = "Not defined">
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    39
<#if property.defaultValue?size &gt; 0>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    40
    <#assign defaultValue = property.defaultValue>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    41
</#if>      
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    42
<tt class="docutils literal">${defaultValue}</tt>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    43
<br/>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    44
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    45
<#if property.deprecated?length &gt; 0>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    46
    <b>Deprecated</b>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    47
    <p>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    48
    ${property.deprecated}
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    49
    </p>        
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    50
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    51
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    52
<hr/>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    53
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    54
<h3>Documentation</h3>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    55
<p>
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    56
${property.documentation}
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    57
</p>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    58
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    59
<hr/>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    60
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    61
<h3>Source code</h3>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    62
<pre>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    63
    ${property.source?html}
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    64
</pre>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    65
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    66
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    67
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    68
<@helium_api_html_footer/>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    69
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    70
</#list>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    71
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    72