feat(ngdocs): support for interface documentation

mhevery · mhevery · commit afd25446d23f · 2012-01-10T22:21:54.000-08:00
diff --git a/docs/src/gen-docs.js b/docs/src/gen-docs.js
@@ -20,7 +20,9 @@ writer.makeDir('build/docs/syntaxhighlighter').then(function() {
   ngdoc.merge(docs);
   var fileFutures = [];
   docs.forEach(function(doc){
-    fileFutures.push(writer.output('partials/' + doc.section + '/' + doc.id + '.html', doc.html()));
+    // this hack is here bocause on OSX angular.module and angular.Module map to the same file.
+    var id = doc.id.replace('angular.Module', 'angular.IModule');
+    fileFutures.push(writer.output('partials/' + doc.section + '/' + id + '.html', doc.html()));
   });
 
   writeTheRest(fileFutures);
diff --git a/docs/src/ngdoc.js b/docs/src/ngdoc.js
@@ -456,7 +456,7 @@ Doc.prototype = {
     dom.html(this.description);
   },
 
-  html_usage_object: function(dom){
+  html_usage_interface: function(dom){
     var self = this;
 
     if (this.param.length) {
@@ -477,7 +477,11 @@ Doc.prototype = {
   },
 
   html_usage_service: function(dom) {
-    this.html_usage_object(dom)
+    this.html_usage_interface(dom)
+  },
+
+  html_usage_object: function(dom) {
+    this.html_usage_interface(dom)
   },
 
   method_properties_events: function(dom) {
@@ -619,15 +623,18 @@ var KEYWORD_PRIORITY = {
   '.index': 1,
   '.guide': 2,
   '.angular': 7,
+  '.angular.Module': 7,
+  '.angular.module': 8,
+  '.angular.mock': 9,
   '.angular.module.ng.$filter': 7,
-  '.angular.Object': 7,
-  '.angular.directive': 7,
   '.angular.module.ng.$filter': 7,
   '.angular.module.ng.$rootScope.Scope': 7,
   '.angular.module.ng': 7,
-  '.angular.inputType': 7,
-  '.angular.widget': 7,
   '.angular.mock': 8,
+  '.angular.directive': 6,
+  '.angular.inputType': 6,
+  '.angular.widget': 6,
+  '.angular.module.ngMock': 8,
   '.dev_guide.overview': 1,
   '.dev_guide.bootstrap': 2,
   '.dev_guide.mvc': 3,
@@ -648,7 +655,7 @@ function keywordSort(a, b){
       mangled.push(KEYWORD_PRIORITY[partialName] || 5);
       mangled.push(name);
     });
-    return doc.section + '/' + mangled.join('.');
+    return (doc.section + '/' + mangled.join('.')).toLowerCase();
   }
   var nameA = mangleName(a);
   var nameB = mangleName(b);
diff --git a/docs/src/templates/docs.js b/docs/src/templates/docs.js
@@ -49,7 +49,9 @@ function DocsController($location, $window, $cookies, $filter) {
   };
 
   scope.getCurrentPartial = function() {
-    return this.partialId ? ('./partials/' + this.sectionId + '/' + this.partialId + '.html') : '';
+    return this.partialId
+        ? ('./partials/' + this.sectionId + '/' + this.partialId.replace('angular.Module', 'angular.IModule') + '.html')
+        : '';
   };
 
   scope.getClass = function(page) {
diff --git a/docs/src/writer.js b/docs/src/writer.js
@@ -11,7 +11,7 @@ exports.output = function(file, content) {
   var fullPath = OUTPUT_DIR + file;
   var dir = parent(fullPath);
   return Q.when(exports.makeDir(dir), function(error) {
-    qfs.write(fullPath,exports.toString(content));
+    qfs.write(fullPath, exports.toString(content));
   });
 };
 
