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

<#--
============================================================================ 
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"/>

<#list doc.antDatabase.project.property as property>
<@pp.changeOutputFile name="property-${property.name}.html" />

<@helium_api_header title="property ${property.name}"/>


    
<h2>Property ${property.name}</h2>

<b>Type: </b>${property.type}<br/>
<b>Scope: </b>${property.scope}<br/>
<b>Editable: </b>${property.editable}<br/>

<b>Default value: </b>
<#assign defaultValue = "Not defined">
<#if property.defaultValue?size &gt; 0>
    <#assign defaultValue = property.defaultValue>
</#if>      
<tt class="docutils literal">${defaultValue}</tt>
<br/>

<#if property.deprecated?length &gt; 0>
    <b>Deprecated</b>
    <p>
    ${property.deprecated}
    </p>        
</#if>

<hr/>

<h3>Documentation</h3>
<p>
${property.documentation}
</p>

<hr/>

<h3>Source code</h3>
<pre>
    ${property.source?html}
</pre>



<@helium_api_html_footer/>

</#list>