add support for @deprecated ng:doc annotation + show warnings in templates

docs/collect.js

@@ -212,6 +212,7 @@ var TAG = {
   namespace: valueTag,
   css: valueTag,
   see: valueTag,
+  deprecated: valueTag,
   usageContent: valueTag,
   'function': valueTag,
   description: markdownTag,

docs/directive.template

@@ -1,4 +1,12 @@
 <h1>{{name}}</h1>
+
+{{#deprecated}}
+<fieldset class="deprecated">
+  <legend>Deprecated API</legend>
+  {{deprecated}}
+</fieldset>
+{{/deprecated}}
+
 <h2>Description</h2>
 {{{description}}}
 

docs/docs.css

@@ -130,3 +130,12 @@ a {
   margin-left: 3em;
   font-family: monospace;
 }
+
+.deprecated {
+  border: 2px solid red;
+}
+
+.deprecated legend {
+  font-weight: bold;
+  color: red;
+}

docs/filter.template

@@ -1,4 +1,12 @@
 <h1>{{name}}</h1>
+
+{{#deprecated}}
+<fieldset class="deprecated">
+  <legend>Deprecated API</legend>
+  {{deprecated}}
+</fieldset>
+{{/deprecated}}
+
 <h2>Description</h2>
 {{{description}}}
 

docs/formatter.template

@@ -1,4 +1,12 @@
 <h1>{{name}}</h1>
+
+{{#deprecated}}
+<fieldset class="deprecated">
+  <legend>Deprecated API</legend>
+  {{deprecated}}
+</fieldset>
+{{/deprecated}}
+
 <h2>Description</h2>
 {{{description}}}
 

docs/function.template

@@ -1,4 +1,12 @@
 <h1>{{name}}</h1>
+
+{{#deprecated}}
+<fieldset class="deprecated">
+  <legend>Deprecated API</legend>
+  {{deprecated}}
+</fieldset>
+{{/deprecated}}
+
 <h2>Description</h2>
 {{{description}}}
 

docs/overview.template

@@ -1,4 +1,12 @@
 <h1>{{name}}</h1>
+
+{{#deprecated}}
+<fieldset class="deprecated">
+  <legend>Deprecated API</legend>
+  {{deprecated}}
+</fieldset>
+{{/deprecated}}
+
 {{{description}}}
 
 {{#example}}

docs/service.template

@@ -1,4 +1,12 @@
 <h1><tt>{{name}}</tt></h1>
+
+{{#deprecated}}
+<fieldset class="deprecated">
+  <legend>Deprecated API</legend>
+  {{deprecated}}
+</fieldset>
+{{/deprecated}}
+
 <h2>Description</h2>
 {{{description}}}
 

docs/spec/collectSpec.js

@@ -182,21 +182,27 @@ describe('collect', function(){
       });
     });
     
-    describe('@describe', function(){
+    describe('@description', function(){
       it('should support pre blocks', function(){
         TAG.description(doc, 'description', '<pre>abc</pre>');
         expect(doc.description).toEqual('<div ng:non-bindable><pre class="brush: js; html-script: true; toolbar: false;">abc</pre></div>');
       });
-      
-      describe('@example', function(){
-        it('should not remove {{}}', function(){
-          TAG.example(doc, 'example', 'text {{ abc }}');
-          expect(doc.example).toEqual('text {{ abc }}');
-        });
-        
+    });
+
+    describe('@example', function(){
+      it('should not remove {{}}', function(){
+        TAG.example(doc, 'example', 'text {{ abc }}');
+        expect(doc.example).toEqual('text {{ abc }}');
       });
     });
 
+    describe('@deprecated', function() {
+      it('should parse @deprecated', function() {
+        TAG.deprecated(doc, 'deprecated', 'Replaced with foo.');
+        expect(doc.deprecated).toBe('Replaced with foo.');
+      })
+    });
+
   });
   
   describe('trim', function(){

docs/validator.template

@@ -1,5 +1,12 @@
 <h1>{{name}}</h1>
 
+{{#deprecated}}
+<fieldset class="deprecated">
+  <legend>Deprecated API</legend>
+  {{deprecated}}
+</fieldset>
+{{/deprecated}}
+
 <h2>Description</h2>
 {{{description}}}
 

docs/widget.template

@@ -1,5 +1,12 @@
 <h1>{{name}}</h1>
 
+{{#deprecated}}
+<fieldset class="deprecated">
+  <legend>Deprecated API</legend>
+  {{deprecated}}
+</fieldset>
+{{/deprecated}}
+
 <h2>Description</h2>
 {{{description}}}