Merge pull request #196 from neatshell/master

feat(docs): visualize @deprecated in sizebar
m7r · Jun 30, 2017 · 580c525 · 580c525
2 parents 847e1ce + ebb1d6e
commit 580c525
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/src/ngdoc.js b/src/ngdoc.js
@@ -1112,7 +1112,7 @@ function scenarios(docs){
 
 
 //////////////////////////////////////////////////////////
-function metadata(docs){
+function metadata(docs) {
   var pages = [];
   docs.forEach(function(doc){
     var path = (doc.name || '').split(/(\:\s*)/);
@@ -1125,6 +1125,11 @@ function metadata(docs){
       shortName = 'input [' + shortName + ']';
     }
 
+    doc.isDeprecated = false;
+    if (doc.deprecated !== undefined) {
+      doc.isDeprecated = true;
+    }
+
     pages.push({
       section: doc.section,
       id: doc.id,
@@ -1133,7 +1138,8 @@ function metadata(docs){
       type: doc.ngdoc,
       moduleName: doc.moduleName,
       shortDescription: doc.shortDescription(),
-      keywords: doc.keywords()
+      keywords: doc.keywords(),
+      isDeprecated: doc.isDeprecated
     });
   });
   pages.sort(sidebarSort);

diff --git a/src/templates/css/docs.css b/src/templates/css/docs.css
@@ -94,6 +94,10 @@ img.AngularJS-small {
   padding-bottom: 6px;
 }
 
+.form-search > ul.nav > li.deprecate {
+  text-decoration: line-through;
+}
+
 .form-search .well {
   border-color: #d3d3d3;
   padding: 0;

diff --git a/src/templates/js/docs.js b/src/templates/js/docs.js
@@ -250,8 +250,8 @@ docsApp.controller.DocsController = function($scope, $location, $window, section
       last: this.$last,
       active: page1 && this.currentPage == page1 || page2 && this.currentPage == page2,
       match: this.focused && this.currentPage != page1 &&
-             this.bestMatch.rank > 0 && this.bestMatch.page == page1
-
+             this.bestMatch.rank > 0 && this.bestMatch.page == page1,
+      deprecate: page1.isDeprecated
     };
   };