diff options
| author | Igor Minar | 2010-11-17 13:24:45 -0800 |
|---|---|---|
| committer | Igor Minar | 2010-11-18 02:34:55 -0800 |
| commit | 28e72cbe6bfb874fa6a7f15769e5c83d66fb617f (patch) | |
| tree | 6eef8420e22ba985f878cff147eab827a780dbf5 | |
| parent | 916dadd8ec4c7e3a9710941faa3d5ea80f615ac0 (diff) | |
| download | angular.js-28e72cbe6bfb874fa6a7f15769e5c83d66fb617f.tar.bz2 | |
CSS, Parameters, Returns template changes
- make css section optional
- make returns section optional
- change format of the parameters section
- properly format the Returns section
| -rw-r--r-- | docs/directive.template | 9 | ||||
| -rw-r--r-- | docs/filter.template | 11 | ||||
| -rw-r--r-- | docs/formatter.template | 6 | ||||
| -rw-r--r-- | docs/function.template | 9 | ||||
| -rw-r--r-- | docs/validator.template | 7 | ||||
| -rw-r--r-- | docs/widget.template | 7 |
6 files changed, 40 insertions, 9 deletions
diff --git a/docs/directive.template b/docs/directive.template index 6fdb6e04..9f1c9659 100644 --- a/docs/directive.template +++ b/docs/directive.template @@ -23,13 +23,18 @@ <h3>Parameters</h3> <ul> {{#param}} - <li><tt>{{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}</tt>: {{{description}}}</li> + <li><tt>{{name}}</tt> – + <tt>{{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}</tt> + <tt>{{#default}}[{{default}}]{{/default}}</tt> + – {{{description}}}</li> {{/param}} </ul> {{{paramDescription}}} -{{#css}}<h3>CSS</h3>{{/css}} +{{#css}} +<h3>CSS</h3> {{{css}}} +{{/css}} {{#example}} <h2>Example</h2> diff --git a/docs/filter.template b/docs/filter.template index c61b4c2b..b8e118a3 100644 --- a/docs/filter.template +++ b/docs/filter.template @@ -26,15 +26,22 @@ angular.filter.{{shortName}}({{paramFirst.name}}{{#paramRest}}, {{name}}{{/param <h3>Parameters</h3> <ul> {{#param}} - <li><tt>{{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}</tt>: {{{description}}}</li> + <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> -{{{returns}}} +<tt>{{{{type}}}}</tt> {{{description}}} +{{/returns}} +{{#css}} <h3>CSS</h3> {{{css}}} +{{/css}} {{#example}} <h2>Example</h2> diff --git a/docs/formatter.template b/docs/formatter.template index 2a9fedd0..0b437d9a 100644 --- a/docs/formatter.template +++ b/docs/formatter.template @@ -21,11 +21,15 @@ var userInputString = angular.formatter.{{shortName}}.format(modelValue);<br/> var modelValue = angular.formatter.{{shortName}}.parse(userInputString); </tt> +{{#returns}} <h3>Returns</h3> -{{{returns}}} +<tt>{{{{type}}}}</tt> {{{description}}} +{{/returns}} +{{#css}} <h3>CSS</h3> {{{css}}} +{{/css}} {{#example}} <h2>Example</h2> diff --git a/docs/function.template b/docs/function.template index f5660314..46a6dc98 100644 --- a/docs/function.template +++ b/docs/function.template @@ -18,12 +18,17 @@ <h3>Parameters</h3> <ul> {{#param}} - <li><tt>{{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}</tt>: {{{description}}}</li> + <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> -{{{returns}}} +<tt>{{{{type}}}}</tt> {{{description}}} +{{/returns}} {{#example}} <h2>Example</h2> diff --git a/docs/validator.template b/docs/validator.template index 1b8687a3..d0863f9f 100644 --- a/docs/validator.template +++ b/docs/validator.template @@ -24,13 +24,18 @@ angular.validator.{{shortName}}({{paramFirst.name}}{{#paramRest}}{{^default}}, { <h3>Parameters</h3> <ul> {{#param}} - <li><tt>{{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}</tt>: {{{description}}}</li> + <li><tt>{{name}}</tt> – + <tt>{{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}</tt> + <tt>{{#default}}[{{default}}]{{/default}}</tt> + – {{{description}}}</li> {{/param}} </ul> {{{paramDescription}}} +{{#css}} <h3>CSS</h3> {{{css}}} +{{/css}} {{#example}} <h2>Example</h2> diff --git a/docs/widget.template b/docs/widget.template index 84566d47..99692950 100644 --- a/docs/widget.template +++ b/docs/widget.template @@ -24,13 +24,18 @@ <h3>Parameters</h3> <ul> {{#param}} - <li><tt>{{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}</tt>: {{{description}}}</li> + <li><tt>{{name}}</tt> – + <tt>{{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}</tt> + <tt>{{#default}}[{{default}}]{{/default}}</tt> + – {{{description}}}</li> {{/param}} </ul> {{{paramDescription}}} +{{#css}} <h3>CSS</h3> {{{css}}} +{{/css}} {{#example}} <h2>Example</h2> |