aboutsummaryrefslogtreecommitdiffstats
path: root/docs/filter.template
diff options
context:
space:
mode:
authorMisko Hevery2010-10-27 15:31:10 -0700
committerIgor Minar2010-11-03 09:47:22 -0700
commit659af29adbd041fbbbaf041ead53266210a61f4e (patch)
tree32a9ecff4482ae883321e2975fe74057795b21d1 /docs/filter.template
parent1fe7e3a1302e948a31ab80d02ede6975c3bddd58 (diff)
downloadangular.js-659af29adbd041fbbbaf041ead53266210a61f4e.tar.bz2
jsdoc parser + generator + viewer + scenario runner
- parse jsdocs from source code - generate prerendered (markdown + mustache) partials - generate json - generate scenario runner for examples in docs - basic angular doc viewer
Diffstat (limited to 'docs/filter.template')
-rw-r--r--docs/filter.template33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/filter.template b/docs/filter.template
new file mode 100644
index 00000000..677a8785
--- /dev/null
+++ b/docs/filter.template
@@ -0,0 +1,33 @@
+<h1><tt>{{name}}</tt></h1>
+<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}}{{#type}}({{type}}){{/type}}</tt>: {{description}}</li>
+ {{/param}}
+</ul>
+
+<h3>Returns</h3>
+{{{returns}}}
+
+<h3>CSS</h3>
+{{{css}}}
+
+<h2>Description</h2>
+{{{description}}}
+
+<WIKI:SOURCE style="display:block;">
+{{example}}
+</WIKI:SOURCE> \ No newline at end of file