grunt-ngdocs - npm Package Compare versions

Comparing version 0.1.7 to 0.1.8

CHANGELOG.md

@@ -0,1 +1,26 @@
+# 0.1.8 (2014-01-06)
+
+## Features
+### docs
+
+* remove angularjs favicon ([8ca93964](https://github.com/m7r/grunt-ngdocs/commit/8ca93964))
+* Preprocess navTemplate via grunt.template ([8840d036](https://github.com/m7r/grunt-ngdocs/commit/8840d036))
+
+### ngdocs
+
+* override module name parsing ([3a92ae93](https://github.com/m7r/grunt-ngdocs/commit/3a92ae93))
+
+
+## Bug fixes
+### docs
+
+* load disqus over https ([2a8de1c0](https://github.com/m7r/grunt-ngdocs/commit/2a8de1c0))
+
+### readme
+
+* fixes link ([4345513d](https://github.com/m7r/grunt-ngdocs/commit/4345513d))
+
+
+
+
 # 0.1.7 (2013-09-13)
@@ -2,0 +27,0 @@

package.json

 {
   "name": "grunt-ngdocs",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "grunt plugin for angularjs documentation",
@@ -5,0 +5,0 @@ "main": "tasks",

README.md

@@ -16,3 +16,3 @@ #grunt-ngdocs
 
-A full working example can be found at [https://github.com/m7r/grunt-ngdocs-example]()
+A full working example can be found at [https://github.com/m7r/grunt-ngdocs-example](https://github.com/m7r/grunt-ngdocs-example)
 
@@ -140,2 +140,4 @@ ##Config
 
+The template, if specified, is pre-processed using [grunt.template](https://github.com/gruntjs/grunt/wiki/grunt.template#grunttemplateprocess).
+
 ###Targets
@@ -192,3 +194,4 @@ Each grunt target creates a section in the documentation app.
 
-See the [AngularJS source code](https://github.com/angular/angular.js/tree/master/src/ng) for more examples.
+Check out the [Writing AngularJS documentation wiki article](https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation) to see what's possible,
+or take a look at the [AngularJS source code](https://github.com/angular/angular.js/tree/master/src/ng) for more examples.
 
@@ -195,0 +198,0 @@ ##Batarang

src/ngdoc.js

@@ -260,3 +260,8 @@ /**
         var text = trim(atText.join('\n')), match;
-        if (atName == 'param') {
+        if (atName == 'module') {
+          match = text.match(/^\s*(\S+)\s*$/);
+          if (match) {
+            self.moduleName = match[1];
+          }
+        } else if (atName == 'param') {
           match = text.match(/^\{([^}]+)\}\s+(([^\s=]+)|\[(\S+)=([^\]]+)\])\s+(.*)/);
@@ -326,3 +331,3 @@ //  1      1    23       3   4   4 5      5  2   6  6
 
-    dom.h(title(this.name, this.ngdoc == 'overview'), function() {
+    dom.h(title(this.moduleName, this.name, this.ngdoc == 'overview'), function() {
 
@@ -768,3 +773,3 @@ notice('deprecated', 'Deprecated API', self.deprecated);
 
-function title(text, overview) {
+function title(module, text, overview) {
   if (!text) return text;
@@ -804,3 +809,3 @@ var match,
   } else if (match = text.match(MODULE_TYPE)) {
-    module = match[1];
+    module = module || match[1];
     name = match[2];
@@ -813,3 +818,3 @@ type = 'type';
     } else {
-      module = match[1];
+      module = module || match[1];
       name = match[2] + (match[3] || '');
@@ -887,3 +892,4 @@ type = 'service';
       id: doc.id,
-      name: title(doc.name),
+      name: title(doc.moduleName, doc.name),
+      moduleName: doc.moduleName,
       shortName: shortName,
@@ -890,0 +896,0 @@ type: doc.ngdoc,

src/templates/js/docs.js

@@ -303,3 +303,3 @@ var docsApp = {
              this.bestMatch.rank > 0 && this.bestMatch.page == page1
-             
+
     };
@@ -366,4 +366,6 @@ };
       } else if (match = partialId.match(MODULE)) {
+        match[1] = page.moduleName || match[1];
         breadcrumb.push({ name: match[1] });
       } else if (match = partialId.match(MODULE_FILTER)) {
+        match[1] = page.moduleName || match[1];
         breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
@@ -379,5 +381,7 @@ breadcrumb.push({ name: match[2] });
       } else if (match = partialId.match(MODULE_CUSTOM)) {
+        match[1] = page.moduleName || match[1];
         breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
         breadcrumb.push({ name: match[3] });
       } else if (match = partialId.match(MODULE_TYPE)) {
+        match[1] = page.moduleName || match[1];
         breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
@@ -390,2 +394,3 @@ breadcrumb.push({ name: match[2] });
         } else {
+          match[1] = page.moduleName || match[1];
           breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
@@ -462,13 +467,13 @@ breadcrumb.push({ name: match[2] + (match[3] || '') });
       } else if (match = id.match(MODULE)) {
-        module(match[1], section);
+        module(page.moduleName || match[1], section);
       } else if (match = id.match(MODULE_FILTER)) {
-        module(match[1], section).filters.push(page);
+        module(page.moduleName || match[1], section).filters.push(page);
       } else if (match = id.match(MODULE_DIRECTIVE)) {
-        module(match[1], section).directives.push(page);
+        module(page.moduleName || match[1], section).directives.push(page);
       } else if (match = id.match(MODULE_DIRECTIVE_INPUT)) {
-        module(match[1], section).directives.push(page);
+        module(page.moduleName || match[1], section).directives.push(page);
       } else if (match = id.match(MODULE_CUSTOM)) {
-        module(match[1], section).others.push(page);
+        module(page.moduleName || match[1], section).others.push(page);
       } else if (match = id.match(MODULE_TYPE)) {
-        module(match[1], section).types.push(page);
+        module(page.moduleName || match[1], section).types.push(page);
       } else if (match = id.match(MODULE_SERVICE)) {
@@ -478,3 +483,3 @@ if (page.type === 'overview') {
         } else {
-          module(match[1], section).service(match[2])[match[3] ? 'provider' : 'instance'] = page;
+          module(page.moduleName || match[1], section).service(match[2])[match[3] ? 'provider' : 'instance'] = page;
         }
@@ -553,3 +558,3 @@ } else if (match = id.match(MODULE_MOCK)) {
       var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
-      dsq.src = 'http://angularjs.disqus.com/embed.js';
+      dsq.src = '//angularjs.disqus.com/embed.js';
       (document.getElementsByTagName('head')[0] ||
@@ -556,0 +561,0 @@ document.getElementsByTagName('body')[0]).appendChild(dsq);

tasks/grunt-ngdocs.js

@@ -105,3 +105,3 @@ /*
     if (options.navTemplate) {
-      options.navContent = grunt.file.read(options.navTemplate);
+      options.navContent = grunt.template.process(grunt.file.read(options.navTemplate));
     } else {
@@ -108,0 +108,0 @@ options.navContent = '';

No alert changes

Improved metrics

Total package byte prevSize

698732

increased by0.06%

Lines of code

9277

increased by0.12%

Number of lines in readme file

201

increased by1.52%

Worsened metrics

Number of package files

26

decreased by-3.7%

No dependency changes