From 28e72cbe6bfb874fa6a7f15769e5c83d66fb617f Mon Sep 17 00:00:00 2001
From: Igor Minar
Date: Wed, 17 Nov 2010 13:24:45 -0800
Subject: CSS, Parameters, Returns template changes
- make css section optional
- make returns section optional
- change format of the parameters section
- properly format the Returns section
---
docs/directive.template | 9 +++++++--
docs/filter.template | 11 +++++++++--
docs/formatter.template | 6 +++++-
docs/function.template | 9 +++++++--
docs/validator.template | 7 ++++++-
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 @@
Parameters
{{#param}}
- - {{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}: {{{description}}}
+ - {{name}} –
+ {{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}
+ {{#default}}[{{default}}]{{/default}}
+ – {{{description}}}
{{/param}}
{{{paramDescription}}}
-{{#css}}CSS
{{/css}}
+{{#css}}
+CSS
{{{css}}}
+{{/css}}
{{#example}}
Example
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
Parameters
{{#param}}
- - {{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}: {{{description}}}
+ - {{name}} –
+ {{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}
+ {{#default}}[{{default}}]{{/default}}
+ – {{{description}}}
{{/param}}
+{{#returns}}
Returns
-{{{returns}}}
+{{{{type}}}} {{{description}}}
+{{/returns}}
+{{#css}}
CSS
{{{css}}}
+{{/css}}
{{#example}}
Example
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);
var modelValue = angular.formatter.{{shortName}}.parse(userInputString);
+{{#returns}}
Returns
-{{{returns}}}
+{{{{type}}}} {{{description}}}
+{{/returns}}
+{{#css}}
CSS
{{{css}}}
+{{/css}}
{{#example}}
Example
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 @@
Parameters
{{#param}}
- - {{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}: {{{description}}}
+ - {{name}} –
+ {{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}
+ {{#default}}[{{default}}]{{/default}}
+ – {{{description}}}
{{/param}}
+{{#returns}}
Returns
-{{{returns}}}
+{{{{type}}}} {{{description}}}
+{{/returns}}
{{#example}}
Example
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}}, {
Parameters
{{#param}}
- - {{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}: {{{description}}}
+ - {{name}} –
+ {{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}
+ {{#default}}[{{default}}]{{/default}}
+ – {{{description}}}
{{/param}}
{{{paramDescription}}}
+{{#css}}
CSS
{{{css}}}
+{{/css}}
{{#example}}
Example
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 @@
Parameters
{{#param}}
- - {{name}}:{{#type}}{{type}}{{/type}}{{^type}}:*{{/type}}{{#default}}={{default}}{{/default}}: {{{description}}}
+ - {{name}} –
+ {{{#type}}{{type}}{{/type}}{{^type}}*{{/type}}{{#optional}}={{/optional}}}
+ {{#default}}[{{default}}]{{/default}}
+ – {{{description}}}
{{/param}}
{{{paramDescription}}}
+{{#css}}
CSS
{{{css}}}
+{{/css}}
{{#example}}
Example
--
cgit v1.2.3