buildframework/helium/doc/api/target.html.ftl
author Ross Qin <ross.qin@nokia.com>
Thu, 28 Oct 2010 11:34:42 +0800
changeset 668 fb8810d63524
parent 587 85df38eb4012
permissions -rw-r--r--
remove the emulatorlauncher

<#--
============================================================================ 
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.target as target>
<@pp.changeOutputFile name="target-${target.name}.html" />

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


    
<h2>Target ${target.name}</h2>

<b>Scope: </b>${target.scope}<br/>

<p><b>Description</b></p>
<p>${target.description}</p>

<p><b>Location</b></p>
<p><@helium_api_location_path location="${target.location}"/></p>

<p><b>Conditional execution</b></p>        
<#if target.ifDependency?length &gt; 0>
<p>Target <b>is</b> run if property defined: <code>${target.ifDependency}</code></p>
</#if>
<#if target.unlessDependency?length &gt; 0>
<p>Target <b>is not</b> run if property defined: <code>${target.unlessDependency}</code></p>
</#if>
<#if target.ifDependency?length == 0 && target.unlessDependency?length == 0>
<p>No conditions on target execution.</p>
</#if>

<#if target.deprecated?length &gt; 0>
    <h3>Deprecated :</h3>
    <p>
    ${target.deprecated}
    </p>
</#if>
<hr/>


<h3>Documentation</h3>
<p>
<#recurse target.documentation>
</p>
<p/>
<hr/>


<#assign executableList=target.executable?sort>
<#if executableList?size &gt; 0>
<h3>Target external Dependency</h3>
<p> 
<table class="docutils" width="50%">
    <tr>
        <th class="head">Name</th>
    </tr>
    <#list executableList as excutable>
        <tr>
                    <td>${excutable}</td>
            </tr>
    </#list>
</table>
</p>
</#if>


<h3>Property dependencies</h3>

<#assign propertyList=target.propertyDependency?sort>
<ul>
    <#list propertyList as property>
    <li>${property}</li>
    </#list>
</ul>
<hr/>


<h3>Target dependencies</h3>
<p align="center">
<img src="target-${target.name}.dot.png" alt="${target.name} dependencies" usemap="#dependencies"
     style="border-style: none"/>
<map name="dependencies" id="dependencies">
  <#attempt>
      <#include "target-${target.name}.dot.cmap"/>
      <#recover>
  </#attempt>
</map>
</p>
<hr/>


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


<@helium_api_html_footer/>

</#list>