feat(): allow additional custom types

`@name my.module.type:name` => name (type in module my.module)
m7r · Jun 27, 2013 · df3103b · df3103b
1 parent 7b7404c
commit df3103b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/src/ngdoc.js b/src/ngdoc.js
@@ -409,11 +409,11 @@ Doc.prototype = {
 
   html_usage_function: function(dom){
     var self = this;
-    var name = self.name.match(/^angular(\.mock)?\.(\w+)$/) ? self.name : self.name.split(/\./).pop()
+    var name = self.name.match(/^angular(\.mock)?\.(\w+)$/) ? self.name : self.name.split(/\./).pop();
 
     dom.h('Usage', function() {
       dom.code(function() {
-        dom.text(name);
+        dom.text(name.split(':').pop());
         dom.text('(');
         self.parameters(dom, ', ');
         dom.text(');');
@@ -746,7 +746,7 @@ var GLOBALS = /^angular\.([^\.]+)$/,
     MODULE_MOCK = /^angular\.mock\.([^\.]+)$/,
     MODULE_DIRECTIVE = /^(.+)\.directive:([^\.]+)$/,
     MODULE_DIRECTIVE_INPUT = /^(.+)\.directive:input\.([^\.]+)$/,
-    MODULE_FILTER = /^(.+)\.filter:([^\.]+)$/,
+    MODULE_CUSTOM = /^(.+)\.([^\.]+):([^\.]+)$/,
     MODULE_SERVICE = /^(.+)\.([^\.]+?)(Provider)?$/,
     MODULE_TYPE = /^([^\.]+)\..+\.([A-Z][^\.]+)$/;
 
@@ -781,10 +781,10 @@ function title(text, overview) {
     module = match[1];
     name = 'input [' + match[2] + ']';
     type = 'directive';
-  } else if (match = text.match(MODULE_FILTER)) {
+  } else if (match = text.match(MODULE_CUSTOM)) {
     module = match[1];
-    name = match[2];
-    type = 'filter';
+    name = match[3];
+    type = match[2];
   } else if (match = text.match(MODULE_TYPE)) {
     module = match[1];
     name = match[2];

diff --git a/src/templates/index.tmpl b/src/templates/index.tmpl
@@ -148,6 +148,10 @@
               <a class="code" href="{{module.url}}">{{module.name}}</a>
             </li>
 
+            <li ng-repeat="page in module.others<%= trackBy('page.url', "'expand'") %>" ng-class="navClass(page)" class="api-list-item">
+              <a href="{{page.url}}" tabindex="2">{{page.shortName}}</a>
+            </li>
+
             <li class="nav-header section" ng-show="module.directives">
               <a class="guide">directive</a>
             </li>

diff --git a/src/templates/js/docs.js b/src/templates/js/docs.js
@@ -284,6 +284,7 @@ docsApp.controller.DocsController = function($scope, $location, $window, section
       MODULE_DIRECTIVE = /^(.+)\.directive:([^\.]+)$/,
       MODULE_DIRECTIVE_INPUT = /^(.+)\.directive:input\.([^\.]+)$/,
       MODULE_FILTER = /^(.+)\.filter:([^\.]+)$/,
+      MODULE_CUSTOM = /^(.+)\.([^\.]+):([^\.]+)$/,
       MODULE_SERVICE = /^(.+)\.([^\.]+?)(Provider)?$/,
       MODULE_TYPE = /^([^\.]+)\..+\.([A-Z][^\.]+)$/;
 
@@ -367,6 +368,9 @@ docsApp.controller.DocsController = function($scope, $location, $window, section
         breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
         breadcrumb.push({ name: 'input' });
         breadcrumb.push({ name: match[2] });
+      } else if (match = partialId.match(MODULE_CUSTOM)) {
+        breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
+        breadcrumb.push({ name: match[3] });
       } else if (match = partialId.match(MODULE_TYPE)) {
         breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
         breadcrumb.push({ name: match[2] });
@@ -453,6 +457,8 @@ docsApp.controller.DocsController = function($scope, $location, $window, section
         module(match[1], section).directives.push(page);
       } else if (match = id.match(MODULE_DIRECTIVE_INPUT)) {
         module(match[1], section).directives.push(page);
+      } else if (match = id.match(MODULE_CUSTOM)) {
+        module(match[1], section).others.push(page);
       } else if (match = id.match(MODULE_TYPE)) {
         module(match[1], section).types.push(page);
       } else if (match = id.match(MODULE_SERVICE)) {
@@ -480,6 +486,7 @@ docsApp.controller.DocsController = function($scope, $location, $window, section
           globals: [],
           directives: [],
           services: [],
+          others: [],
           service: function(name) {
             var service =  cache[this.name + ':' + name];
             if (!service) {