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