plugins/dali-script-v8/docs/dali-theme/partials/props.handlebars

   1 <div id="property_{{name}}" class="property item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
   2     <h3 class="name"><code>{{name}}</code></h3>
   3     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
   4
   5     {{#if deprecated}}
   6         <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
   7     {{/if}}
   8
   9     {{#if access}}
  10         <span class="flag {{access}}">{{access}}</span>
  11     {{/if}}
  12
  13     {{#if final}}
  14         <span class="flag final">final</span>
  15     {{/if}}
  16
  17     {{#if static}}
  18         <span class="flag static">static</span>
  19     {{/if}}
  20
  21     <div class="meta">
  22         {{#if overwritten_from}}
  23             <p>Inherited from
  24             <a href="{{crossLinkRaw overwritten_from/class}}#property_{{overwritten_from/name}}">
  25                 {{overwritten_from/class}}
  26             </a>
  27             {{#if foundAt}}
  28             but overwritten in
  29             {{/if}}
  30         {{else}}
  31             {{#if extended_from}}
  32                 <p>Inherited from
  33                 <a href="{{crossLinkRaw extended_from}}#property_{{name}}">{{extended_from}}</a>:
  34             {{else}}
  35                 {{#providedBy}}
  36                     <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
  37                 {{/providedBy}}
  38                 <p>
  39                 {{#if foundAt}}
  40                 Defined in
  41                 {{/if}}
  42             {{/if}}
  43         {{/if}}
  44         {{#if foundAt}}
  45         <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
  46         {{/if}}
  47         </p>
  48
  49         {{#if deprecationMessage}}
  50             <p>Deprecated: {{deprecationMessage}}</p>
  51         {{/if}}
  52
  53         {{#if since}}
  54             <p>Available since {{since}}</p>
  55         {{/if}}
  56     </div>
  57
  58     <div class="description">
  59         {{{propertyDescription}}}
  60     </div>
  61
  62     {{#if default}}
  63         <p><strong>Default:</strong> {{default}}</p>
  64     {{/if}}
  65
  66     {{#example}}
  67         <div class="example">
  68             <h4>Example:</h4>
  69
  70             <div class="example-content">
  71                 {{{.}}}
  72             </div>
  73         </div>
  74     {{/example}}
  75
  76     {{#if subprops}}
  77         <h4>Sub-properties:</h4>
  78
  79         <ul class="params-list">
  80             {{#subprops}}
  81             <li class="param">
  82                 {{#if optional}}
  83                     <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
  84                     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
  85                     <span class="flag optional" title="This property is optional.">optional</span>
  86                 {{else}}
  87                     <code class="param-name">{{name}}</code>
  88                     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
  89                 {{/if}}
  90
  91                 <div class="param-description">
  92                     {{{description}}}
  93                 </div>
  94
  95                 {{#if subprops}}
  96                     <ul class="params-list">
  97                         {{#subprops}}
  98                         <li class="param">
  99                             {{#if optional}}
 100                                 <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
 101                                 <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 102                                 <span class="flag optional" title="This property is optional.">optional</span>
 103                             {{else}}
 104                                 <code class="param-name">{{name}}</code>
 105                                 <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 106                             {{/if}}
 107
 108                             <div class="param-description">
 109                                 {{{description}}}
 110                             </div>
 111                         </li>
 112                         {{/subprops}}
 113                     </ul>
 114                 {{/if}}
 115             </li>
 116             {{/subprops}}
 117         </ul>
 118     {{/if}}
 119 </div>