mirror of
https://github.com/Hopiu/angular.js.git
synced 2026-03-17 07:40:22 +00:00
28e72cbe6b
- make css section optional - make returns section optional - change format of the parameters section - properly format the Returns section
57 lines
1.2 KiB
Text
57 lines
1.2 KiB
Text
<h1>{{name}}</h1>
|
||
|
||
{{#deprecated}}
|
||
<fieldset class="deprecated">
|
||
<legend>Deprecated API</legend>
|
||
{{deprecated}}
|
||
</fieldset>
|
||
{{/deprecated}}
|
||
|
||
<h2>Description</h2>
|
||
{{{description}}}
|
||
|
||
<h2>Usage</h2>
|
||
<h3>In HTML Template Binding</h3>
|
||
<tt>
|
||
<span>{{</span>
|
||
{{paramFirst.name}}_expression
|
||
| {{shortName}}{{#paramRest}}{{^default}}:{{name}}{{/default}}{{#default}}<i>[:{{name}}={{default}}]</i>{{/default}}{{/paramRest}}
|
||
<span> }}</span>
|
||
</tt>
|
||
<h3>In JavaScript</h3>
|
||
<tt ng:non-bindable>
|
||
angular.filter.{{shortName}}({{paramFirst.name}}{{#paramRest}}, {{name}}{{/paramRest}} );
|
||
</tt>
|
||
|
||
<h3>Parameters</h3>
|
||
<ul>
|
||
{{#param}}
|
||
<li><tt>{{name}}</tt> –
|
||
<tt>{{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}</tt>
|
||
<tt>{{#default}}[{{default}}]{{/default}}</tt>
|
||
– {{{description}}}</li>
|
||
{{/param}}
|
||
</ul>
|
||
|
||
{{#returns}}
|
||
<h3>Returns</h3>
|
||
<tt>{{{{type}}}}</tt> {{{description}}}
|
||
{{/returns}}
|
||
|
||
{{#css}}
|
||
<h3>CSS</h3>
|
||
{{{css}}}
|
||
{{/css}}
|
||
|
||
{{#example}}
|
||
<h2>Example</h2>
|
||
{{{exampleDescription}}}
|
||
<doc:example>
|
||
<doc:source>
|
||
{{/example}}
|
||
{{{example}}}
|
||
{{#example}}
|
||
</doc:source>
|
||
<doc:scenario>{{{scenario}}}</doc:scenario>
|
||
</doc:example>
|
||
{{/example}}
|