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

   1 <div id="method_{{name}}" class="method item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
   2     <h3 class="name"><code>{{name}}</code></h3>
   3
   4     {{#if params}}
   5         <div class="args">
   6             <span class="paren">(</span><ul class="args-list inline commas">
   7             {{#params}}
   8                 <li class="arg">
   9                     {{#if optional}}
  10                         <code class="optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
  11                     {{else}}
  12                         <code>{{name}}</code>
  13                     {{/if}}
  14                 </li>
  15             {{/params}}
  16             </ul><span class="paren">)</span>
  17         </div>
  18     {{else}}
  19         <span class="paren">()</span>
  20     {{/if}}
  21
  22     {{#if return}}
  23         <span class="returns-inline">
  24             <span class="type">{{#crossLink returnType}}{{/crossLink}}</span>
  25         </span>
  26     {{/if}}
  27
  28     {{#if deprecated}}
  29         <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
  30     {{/if}}
  31
  32     {{#if access}}
  33         <span class="flag {{access}}">{{access}}</span>
  34     {{/if}}
  35
  36     {{#if final}}
  37         <span class="flag final">final</span>
  38     {{/if}}
  39
  40     {{#if static}}
  41         <span class="flag static">static</span>
  42     {{/if}}
  43
  44     {{#if chainable}}
  45         <span class="flag chainable">chainable</span>
  46     {{/if}}
  47
  48     {{#if async}}
  49         <span class="flag async">async</span>
  50     {{/if}}
  51
  52     <div class="meta">
  53         {{#if overwritten_from}}
  54             <p>Inherited from
  55             <a href="{{crossLinkRaw overwritten_from/class}}#method_{{overwritten_from/name}}">
  56                 {{overwritten_from/class}}
  57             </a>
  58             {{#if foundAt}}
  59             but overwritten in
  60             {{/if}}
  61         {{else}}
  62             {{#if extended_from}}
  63                 <p>Inherited from
  64                 <a href="{{crossLinkRaw extended_from}}#method_{{name}}">{{extended_from}}</a>:
  65             {{else}}
  66                 {{#providedBy}}
  67                     <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
  68                 {{/providedBy}}
  69                 <p>
  70                 {{#if foundAt}}
  71                 Defined in
  72                 {{/if}}
  73             {{/if}}
  74         {{/if}}
  75         {{#if foundAt}}
  76         <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
  77         {{/if}}
  78         </p>
  79
  80
  81         {{#if deprecationMessage}}
  82             <p>Deprecated: {{deprecationMessage}}</p>
  83         {{/if}}
  84
  85         {{#if since}}
  86             <p>Available since {{since}}</p>
  87         {{/if}}
  88     </div>
  89
  90     <div class="description">
  91         {{{methodDescription}}}
  92     </div>
  93
  94     {{#if params}}
  95         <div class="params">
  96             <h4>Parameters:</h4>
  97
  98             <ul class="params-list">
  99             {{#params}}
 100                 <li class="param">
 101                     {{#if optional}}
 102                         <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
 103                         <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 104                         <span class="flag optional" title="This parameter is optional.">optional</span>
 105                     {{else}}
 106                         <code class="param-name">{{name}}</code>
 107                         <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 108                     {{/if}}
 109
 110                     {{#if multiple}}
 111                         <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
 112                     {{/if}}
 113
 114                     <div class="param-description">
 115                         {{{description}}}
 116                     </div>
 117
 118                     {{#if props}}
 119                         <ul class="params-list">
 120                             {{#props}}
 121                             <li class="param">
 122                                 {{#if optional}}
 123                                     <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
 124                                     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 125                                     <span class="flag optional" title="This parameter is optional.">optional</span>
 126                                 {{else}}
 127                                     <code class="param-name">{{name}}</code>
 128                                     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 129                                 {{/if}}
 130
 131                                 <div class="param-description">
 132                                     {{{description}}}
 133                                 </div>
 134
 135                                 {{#if props}}
 136                                     <ul class="params-list">
 137                                         {{#props}}
 138                                         <li class="param">
 139                                             {{#if optional}}
 140                                                 <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
 141                                                 <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 142                                                 <span class="flag optional" title="This parameter is optional.">optional</span>
 143                                             {{else}}
 144                                                 <code class="param-name">{{name}}</code>
 145                                                 <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 146                                             {{/if}}
 147
 148                                             <div class="param-description">
 149                                                 {{{description}}}
 150                                             </div>
 151                                         </li>
 152                                         {{/props}}
 153                                     </ul>
 154                                 {{/if}}
 155                             </li>
 156                             {{/props}}
 157                         </ul>
 158                     {{/if}}
 159                 </li>
 160             {{/params}}
 161             </ul>
 162         </div>
 163     {{/if}}
 164
 165     {{#return}}
 166         <div class="returns">
 167             <h4>Returns:</h4>
 168
 169             <div class="returns-description">
 170                 {{#if description}}
 171                     {{#if type}}
 172                         <span class="type">{{#crossLink type}}{{/crossLink}}</span>:
 173                     {{/if}}
 174                     {{{description}}}
 175                 {{else}}
 176                     {{#if type}}
 177                         <span class="type">{{#crossLink type}}{{/crossLink}}</span>:
 178                     {{/if}}
 179                 {{/if}}
 180             </div>
 181         </div>
 182     {{/return}}
 183
 184     {{#throws}}
 185         <div class="throws">
 186             <h4>Throws:</h4>
 187
 188             <div class="throws-description">
 189                 {{#if description}}
 190                     {{#if type}}
 191                         <span class="type">{{#crossLink type}}{{/crossLink}}</span>:
 192                     {{/if}}
 193                     {{{description}}}
 194                 {{else}}
 195                     {{#if type}}
 196                         <span class="type">{{#crossLink type}}{{/crossLink}}</span>:
 197                     {{/if}}
 198                 {{/if}}
 199             </div>
 200         </div>
 201     {{/throws}}
 202
 203     {{#example}}
 204         <div class="example">
 205             <h4>Example:</h4>
 206
 207             <div class="example-content">
 208                 {{{.}}}
 209             </div>
 210         </div>
 211     {{/example}}
 212 </div>