aboutsummaryrefslogtreecommitdiffstats
path: root/docs/function.template
diff options
context:
space:
mode:
authorIgor Minar2010-11-15 23:07:56 -0800
committerIgor Minar2010-11-18 02:34:30 -0800
commit7d6f5f986e374964d1467b6408f5ac8faa2985ba (patch)
treebdd4ed57b9110758453fab39ce41241e5774f5ec /docs/function.template
parentbeeb5ff908b2f30465263fb36c58ddb217dc2a0c (diff)
downloadangular.js-7d6f5f986e374964d1467b6408f5ac8faa2985ba.tar.bz2
add function.template
Diffstat (limited to 'docs/function.template')
-rw-r--r--docs/function.template31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/function.template b/docs/function.template
new file mode 100644
index 00000000..8e89cd18
--- /dev/null
+++ b/docs/function.template
@@ -0,0 +1,31 @@
+<h1>{{name}}</h1>
+<h2>Description</h2>
+{{{description}}}
+
+<h2>Usage</h2>
+<tt ng:non-bindable>
+{{name}}({{paramFirst.name}}{{#paramRest}}, {{name}}{{/paramRest}} );
+</tt>
+
+<h3>Parameters</h3>
+<ul>
+ {{#param}}
+ <li><tt>{{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}</tt>: {{{description}}}</li>
+ {{/param}}
+</ul>
+
+<h3>Returns</h3>
+{{{returns}}}
+
+{{#example}}
+<h2>Example</h2>
+{{{exampleDescription}}}
+<doc:example>
+ <doc:source>
+{{/example}}
+ {{{example}}}
+{{#example}}
+ </doc:source>
+ <doc:scenario>{{{scenario}}}</doc:scenario>
+</doc:example>
+{{/example}}