buildframework/helium/doc/src/api/project.html.ftl
author timothy.murphy@nokia.com
Sun, 28 Feb 2010 22:37:15 +0000
branchfix
changeset 282 99ac65572b14
parent 1 be27ed110b50
child 217 0f5e3a7fb6af
permissions -rw-r--r--
fix: use gethostname() to set host attribute as this works on a cluster whereas reading the COMPUTERNAME env var doesn't.

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

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


    
<h2>Project ${project.name}</h2>

<p><b>Location</b></p>
<#if (project[".//target"]?size > 0)>
<p><@helium_project_path location="${project.target[0].location}"/></p>
</#if>
<h3>Description</h3>
<p>
<#recurse project.documentation>
</p>
<p/>
<hr/>


<h3>Targets</h3>
<table class="docutils">
    <tr>
        <th class="head">Target name</th><th class="head">Description</th>
    </tr>
    <#assign targetInfo = {}>
    <#list project.target as target>
        <#assign targetInfo = targetInfo + {target.name: target.documentation}>
    </#list>
    <#list targetInfo?keys?sort as name>
        <tr>
            <td><a href="target-${name}.html" target="classframe">${name}</a></td><td><#recurse targetInfo[name]></td>
        </tr>
    </#list>
</table>

<h3>Properties</h3>

<#assign propertymodel=data.heliumDataModel.property>
<#assign propertylist=project.property>
<#list propertymodel as propertyInModel>
<#list propertylist as propertyvar>
    <#if propertyvar.name == propertyInModel.name>
        <font class="frameitemfont">
        <a href="property-${propertyvar.name}.html" title="${propertyvar.name}" target="classframe">${propertyvar.name}</a>
        </font>
        <br/>
    </#if>
</#list>
</#list>

<h3>File Includes</h3>
<#assign filelist=project.fileDependency>
<#list filelist as filelistvar>
<font class="frameitemfont">
${filelistvar}
</font>
<br/>
</#list>

<h3>Python Modules</h3>
<#assign pymodulelist=project.pythonDependency>
<#list pymodulelist.module as pymodulevar>
  <#if pymodulevar?size &gt; 0>        
    <font class="frameitemfont">
      ${pymodulevar}
    </font>  
  </#if>
<br/>
</#list>
        


<@helium_api_html_footer/>

</#list>