diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/collect.js | 3 | ||||
| -rw-r--r-- | docs/directive.template | 8 | ||||
| -rw-r--r-- | docs/docs.css | 9 | ||||
| -rw-r--r-- | docs/filter.template | 8 | ||||
| -rw-r--r-- | docs/formatter.template | 8 | ||||
| -rw-r--r-- | docs/function.template | 8 | ||||
| -rw-r--r-- | docs/overview.template | 8 | ||||
| -rw-r--r-- | docs/service.template | 8 | ||||
| -rw-r--r-- | docs/spec/collectSpec.js | 12 | ||||
| -rw-r--r-- | docs/validator.template | 8 | ||||
| -rw-r--r-- | docs/widget.template | 8 |
11 files changed, 88 insertions, 0 deletions
diff --git a/docs/collect.js b/docs/collect.js index 7fe326b4..17d5acb0 100644 --- a/docs/collect.js +++ b/docs/collect.js @@ -240,6 +240,9 @@ var TAG = { css: valueTag, see: valueTag, deprecated: valueTag, + workInProgress: function(doc, name, value) { + doc[name] = {description: markdown(value)}; + }, usageContent: valueTag, 'function': valueTag, description: markdownTag, diff --git a/docs/directive.template b/docs/directive.template index 9f1c9659..07e38ea7 100644 --- a/docs/directive.template +++ b/docs/directive.template @@ -1,5 +1,13 @@ <h1>{{name}}</h1> +{{#workInProgress}} +<fieldset class="workInProgress"> + <legend>Work In Progress</legend> + This page is currently being revised. It might be incomplete or contain inaccuracies. + {{{workInProgress.description}}} +</fieldset> +{{/workInProgress}} + {{#deprecated}} <fieldset class="deprecated"> <legend>Deprecated API</legend> diff --git a/docs/docs.css b/docs/docs.css index 75569e0f..4ade0405 100644 --- a/docs/docs.css +++ b/docs/docs.css @@ -159,3 +159,12 @@ a { font-weight: bold; color: red; } + +.workInProgress { + border: 2px solid orange; +} + +.workInProgress legend { + font-weight: bold; + color: orange; +} diff --git a/docs/filter.template b/docs/filter.template index b8e118a3..516957d0 100644 --- a/docs/filter.template +++ b/docs/filter.template @@ -1,5 +1,13 @@ <h1>{{name}}</h1> +{{#workInProgress}} +<fieldset class="workInProgress"> + <legend>Work In Progress</legend> + This page is currently being revised. It might be incomplete or contain inaccuracies. + {{{workInProgress.description}}} +</fieldset> +{{/workInProgress}} + {{#deprecated}} <fieldset class="deprecated"> <legend>Deprecated API</legend> diff --git a/docs/formatter.template b/docs/formatter.template index 0b437d9a..9ccdc811 100644 --- a/docs/formatter.template +++ b/docs/formatter.template @@ -1,5 +1,13 @@ <h1>{{name}}</h1> +{{#workInProgress}} +<fieldset class="workInProgress"> + <legend>Work In Progress</legend> + This page is currently being revised. It might be incomplete or contain inaccuracies. + {{{workInProgress.description}}} +</fieldset> +{{/workInProgress}} + {{#deprecated}} <fieldset class="deprecated"> <legend>Deprecated API</legend> diff --git a/docs/function.template b/docs/function.template index 46a6dc98..8765277b 100644 --- a/docs/function.template +++ b/docs/function.template @@ -1,5 +1,13 @@ <h1>{{name}}</h1> +{{#workInProgress}} +<fieldset class="workInProgress"> + <legend>Work In Progress</legend> + This page is currently being revised. It might be incomplete or contain inaccuracies. + {{{workInProgress.description}}} +</fieldset> +{{/workInProgress}} + {{#deprecated}} <fieldset class="deprecated"> <legend>Deprecated API</legend> diff --git a/docs/overview.template b/docs/overview.template index 5d3972d7..9902a16f 100644 --- a/docs/overview.template +++ b/docs/overview.template @@ -1,5 +1,13 @@ <h1>{{name}}</h1> +{{#workInProgress}} +<fieldset class="workInProgress"> + <legend>Work In Progress</legend> + This page is currently being revised. It might be incomplete or contain inaccuracies. + {{{workInProgress.description}}} +</fieldset> +{{/workInProgress}} + {{#deprecated}} <fieldset class="deprecated"> <legend>Deprecated API</legend> diff --git a/docs/service.template b/docs/service.template index 4328c21e..ee3a284e 100644 --- a/docs/service.template +++ b/docs/service.template @@ -1,5 +1,13 @@ <h1><tt>{{name}}</tt></h1> +{{#workInProgress}} +<fieldset class="workInProgress"> + <legend>Work In Progress</legend> + This page is currently being revised. It might be incomplete or contain inaccuracies. + {{{workInProgress.description}}} +</fieldset> +{{/workInProgress}} + {{#deprecated}} <fieldset class="deprecated"> <legend>Deprecated API</legend> diff --git a/docs/spec/collectSpec.js b/docs/spec/collectSpec.js index 2261b7a0..8002e0d6 100644 --- a/docs/spec/collectSpec.js +++ b/docs/spec/collectSpec.js @@ -230,6 +230,18 @@ describe('collect', function(){ }) }); + describe('@workInProgress', function() { + it('should parse @workInProgress without a description and default to true', function() { + TAG.workInProgress(doc, 'workInProgress', ''); + expect(doc.workInProgress).toEqual({description: ''}); + }); + + it('should parse @workInProgress with a description', function() { + TAG.workInProgress(doc, 'workInProgress', 'my description'); + expect(doc.workInProgress).toEqual({description: '<p>my description</p>'}); + }); + }); + }); describe('trim', function(){ diff --git a/docs/validator.template b/docs/validator.template index d0863f9f..64ab37b7 100644 --- a/docs/validator.template +++ b/docs/validator.template @@ -1,5 +1,13 @@ <h1>{{name}}</h1> +{{#workInProgress}} +<fieldset class="workInProgress"> + <legend>Work In Progress</legend> + This page is currently being revised. It might be incomplete or contain inaccuracies. + {{{workInProgress.description}}} +</fieldset> +{{/workInProgress}} + {{#deprecated}} <fieldset class="deprecated"> <legend>Deprecated API</legend> diff --git a/docs/widget.template b/docs/widget.template index b954f07c..418ad407 100644 --- a/docs/widget.template +++ b/docs/widget.template @@ -1,5 +1,13 @@ <h1>{{name}}</h1> +{{#workInProgress}} +<fieldset class="workInProgress"> + <legend>Work In Progress</legend> + This page is currently being revised. It might be incomplete or contain inaccuracies. + {{{workInProgress.description}}} +</fieldset> +{{/workInProgress}} + {{#deprecated}} <fieldset class="deprecated"> <legend>Deprecated API</legend> |