Files
ionic-framework/docs/templates/api/directive.template.html
Andy Joslin 55089042d8 chore(build): documentation generation
Main changes:

* Use gulpfile now (build was getting way too disorganized with custom
tasks; gulpfiles are much easier to build clean custom tasks with than
Grunt.
* View README#Development for updated commands
* Docs written for ionContent, ionHeaderBar, ionInfiniteScroll.
* Docs are pushed to ajoslin's fork of ionic-site until they reach a
* point where they can be published.

**TODO, In Order of Priority**

1. Finish writing source-documentation for all existing components
2. Add multiple versions of docs (one per release & nightly, latest
 stable release docs being shown by default)
3. Add examples generation
4. Add searchbar to docs
2014-03-07 13:36:36 -07:00

54 lines
1.1 KiB
HTML

<@ include "lib/macros.html" -@>
<@ extends "api/api.template.html" @>
<@ block additional @>
<@ block usage @>
## Usage
<@ if doc.usage @>
<$ doc.usage $>
<@ else @>
<@ if doc.restrict.element @>
```html
<<$ doc.name | dashCase $>
<@- for param in doc.params @>
<$ directiveParam(param.alias or param.name, param.type, '="', '"') $>
<@- endfor @>>
...
</<$ doc.name | dashCase $>>
```
<@ endif -@>
<@- if doc.restrict.attribute -@>
```html
<<$ doc.element $>
<@- for param in doc.params @>
<$ directiveParam(param.name, param.type, '="', '"') $>
<@- endfor @>>
...
</<$ doc.element $>>
```
<@ endif -@>
<@- if doc.restrict.cssClass -@>
```html
<@ set sep = joiner(' ') @>
<<$ doc.element $> class="
<@- for param in doc.params -@>
<$ sep() $><$ directiveParam(param.name, param.type, ': ', ';') $>
<@- endfor @>"> ... </<$ doc.element $>>
```
<@ endif -@>
<@- endif @>
<@ endblock -@>
<@ include "lib/params.template.html" @>
<@ include "lib/events.template.html" @>
<@ endblock @>