buildframework/helium/doc/api_rst/project.rst.ftl
changeset 640 ac0bbc1e5d79
parent 628 7c4a911dc066
equal deleted inserted replaced
639:0e65f93be3cb 640:ac0bbc1e5d79
    69 <#if target.description?length &gt; 0>
    69 <#if target.description?length &gt; 0>
    70 :Description: ${target.description}
    70 :Description: ${target.description}
    71 </#if>
    71 </#if>
    72 :Location: <@helium_api_location_path location="${target.location}"/>
    72 :Location: <@helium_api_location_path location="${target.location}"/>
    73 :Scope: ${target.scope}
    73 :Scope: ${target.scope}
       
    74 <#if target.since?length &gt; 0>
       
    75 :Since: ${target.since}
       
    76 </#if>
    74 <#if target.ifDependency?length &gt; 0>
    77 <#if target.ifDependency?length &gt; 0>
    75 :Condition: Target **is** run if property defined: :hlm-p:`${target.ifDependency}`
    78 :Condition: Target **is** run if property defined: :hlm-p:`${target.ifDependency}`
    76 </#if>
    79 </#if>
    77 <#if target.unlessDependency?length &gt; 0>
    80 <#if target.unlessDependency?length &gt; 0>
    78 :Condition: Target **is not** run if property defined: ``${target.unlessDependency}``
    81 :Condition: Target **is not** run if property defined: ``${target.unlessDependency}``
    79 </#if>
    82 </#if>
       
    83 
    80 
    84 
    81 <#recurse target.documentation>
    85 <#recurse target.documentation>
    82 
    86 
    83 <#assign propertyList=target.propertyDependency?sort>   
    87 <#assign propertyList=target.propertyDependency?sort>   
    84 <#if propertyList?size &gt; 0>
    88 <#if propertyList?size &gt; 0>
    85 **Property dependencies**
    89 **Property dependencies**
    86 
    90 
    87 <#list propertyList as property>
    91 <#list propertyList as property>
    88 - :hlm-p:`${property}`
    92 - :hlm-p:`${property}`
       
    93 </#list>
       
    94 </#if>
       
    95 
       
    96 
       
    97 <#assign signalsList=target.signal?sort>   
       
    98 <#if signalsList?size &gt; 0>
       
    99 **Signals**
       
   100 
       
   101 <#list signalsList as signal>
       
   102 - ``${signal}``
    89 </#list>
   103 </#list>
    90 </#if>
   104 </#if>
    91 
   105 
    92 
   106 
    93 **Target dependencies**
   107 **Target dependencies**
   137 </#if>
   151 </#if>
   138 
   152 
   139 :Location: <@helium_api_location_path location="${property.location}"/>
   153 :Location: <@helium_api_location_path location="${property.location}"/>
   140 :Type: ${property.type}
   154 :Type: ${property.type}
   141 :Scope: ${property.scope}
   155 :Scope: ${property.scope}
       
   156 <#if property.scope?length &gt; 0>
       
   157 :Since: ${property.since}
       
   158 </#if>
   142 :Editable: ${property.editable}
   159 :Editable: ${property.editable}
   143 <#if property.defaultValue?size &gt; 1>
   160 <#if property.defaultValue?size &gt; 1>
   144 :Default value: ``${property.defaultValue}``
   161 :Default value: ``${property.defaultValue}``
   145 </#if>
   162 </#if>
   146 
   163 
   178 ..warning:: ${macro.deprecated}
   195 ..warning:: ${macro.deprecated}
   179 </#if>
   196 </#if>
   180 
   197 
   181 :Location: <@helium_api_location_path location="${macro.location}"/>
   198 :Location: <@helium_api_location_path location="${macro.location}"/>
   182 :Scope: ${macro.scope}
   199 :Scope: ${macro.scope}
       
   200 <#if macro.scope?length &gt; 0>
       
   201 :Since: ${macro.since}
       
   202 </#if>
   183 
   203 
   184 <#recurse macro.documentation>
   204 <#recurse macro.documentation>
   185 
   205 
   186 **Usage**
   206 **Usage**
   187 
   207