buildframework/helium/doc/src/api/project.html.ftl
changeset 1 be27ed110b50
child 217 0f5e3a7fb6af
equal deleted inserted replaced
0:044383f39525 1:be27ed110b50
       
     1 <#--
       
     2 ============================================================================ 
       
     3 Name        : 
       
     4 Part of     : Helium 
       
     5 
       
     6 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     7 All rights reserved.
       
     8 This component and the accompanying materials are made available
       
     9 under the terms of the License "Eclipse Public License v1.0"
       
    10 which accompanies this distribution, and is available
       
    11 at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
    12 
       
    13 Initial Contributors:
       
    14 Nokia Corporation - initial contribution.
       
    15 
       
    16 Contributors:
       
    17 
       
    18 Description:
       
    19 
       
    20 ============================================================================
       
    21 -->
       
    22 <#include "api.ftllib"/>
       
    23 
       
    24 <#list doc.antDatabase.project as project>
       
    25 <@pp.changeOutputFile name="project-${project.name}.html" />
       
    26 
       
    27 <@helium_api_header title="Project ${project.name}"/>
       
    28 
       
    29 
       
    30     
       
    31 <h2>Project ${project.name}</h2>
       
    32 
       
    33 <p><b>Location</b></p>
       
    34 <#if (project[".//target"]?size > 0)>
       
    35 <p><@helium_project_path location="${project.target[0].location}"/></p>
       
    36 </#if>
       
    37 <h3>Description</h3>
       
    38 <p>
       
    39 <#recurse project.documentation>
       
    40 </p>
       
    41 <p/>
       
    42 <hr/>
       
    43 
       
    44 
       
    45 <h3>Targets</h3>
       
    46 <table class="docutils">
       
    47     <tr>
       
    48         <th class="head">Target name</th><th class="head">Description</th>
       
    49     </tr>
       
    50     <#assign targetInfo = {}>
       
    51     <#list project.target as target>
       
    52         <#assign targetInfo = targetInfo + {target.name: target.documentation}>
       
    53     </#list>
       
    54     <#list targetInfo?keys?sort as name>
       
    55         <tr>
       
    56             <td><a href="target-${name}.html" target="classframe">${name}</a></td><td><#recurse targetInfo[name]></td>
       
    57         </tr>
       
    58     </#list>
       
    59 </table>
       
    60 
       
    61 <h3>Properties</h3>
       
    62 
       
    63 <#assign propertymodel=data.heliumDataModel.property>
       
    64 <#assign propertylist=project.property>
       
    65 <#list propertymodel as propertyInModel>
       
    66 <#list propertylist as propertyvar>
       
    67     <#if propertyvar.name == propertyInModel.name>
       
    68         <font class="frameitemfont">
       
    69         <a href="property-${propertyvar.name}.html" title="${propertyvar.name}" target="classframe">${propertyvar.name}</a>
       
    70         </font>
       
    71         <br/>
       
    72     </#if>
       
    73 </#list>
       
    74 </#list>
       
    75 
       
    76 <h3>File Includes</h3>
       
    77 <#assign filelist=project.fileDependency>
       
    78 <#list filelist as filelistvar>
       
    79 <font class="frameitemfont">
       
    80 ${filelistvar}
       
    81 </font>
       
    82 <br/>
       
    83 </#list>
       
    84 
       
    85 <h3>Python Modules</h3>
       
    86 <#assign pymodulelist=project.pythonDependency>
       
    87 <#list pymodulelist.module as pymodulevar>
       
    88   <#if pymodulevar?size &gt; 0>        
       
    89     <font class="frameitemfont">
       
    90       ${pymodulevar}
       
    91     </font>  
       
    92   </#if>
       
    93 <br/>
       
    94 </#list>
       
    95         
       
    96 
       
    97 
       
    98 <@helium_api_html_footer/>
       
    99 
       
   100 </#list>
       
   101 
       
   102