angular-jsdoc - npm Package Compare versions

Comparing version 0.1.1 to 0.3.0

package.json

 {
   "name": "angular-jsdoc",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "JsDoc Plugin and Template for AngularJs",
@@ -9,6 +9,9 @@ "main": "index.js",
   },
-  "author": "Allen Kim <[e-mail]>",
+  "author": {
+    "name": "Allen Kim",
+    "email": "[e-mail]"
+  },
   "license": "MIT",
   "dependencies": {
-    "jsdoc": "~3.3.0-alpha9"
+    "jsdoc": "~3.3.0-alpha11"
   },
@@ -21,3 +24,9 @@ "devDependencies": {
     "gulp-shell": "~0.2.7"
-  }
+  },
+  "readme": "Angular-JSDoc\n=============\nAngularJS Template for JSDoc 3.  \nA simple collection of JSDoc plugin and template for AngularJS, nothing else!  \n\nFeatures\n----------\n  * Right side table of contents for navigation by Directives, Services, Controllers, etc\n  * Read and process @ngdoc tag\n\nHow Does It Look Like\n---------------------\n  * [angularjs-goolge-maps Documentation](https://rawgit.com/allenhwkim/angularjs-google-maps/master/build/docs/index.html)\n\nInstall\n-------\n    $ npm install jsdoc angular-jsdoc --save-dev\n  \nRun\n---\nRun jsdoc command to generate your documentation. \nAll command line options are the options of [jsdoc](http://usejsdoc.org/about-commandline.html)  \n    \n    $ path/to/jsdoc -c path to conf> -t <template> <your source code>\n\nIn example,  \n\n    `$ node_modules/jsdoc/jsdoc.js -c node_modules/angular-jsdoc/conf -t node_modules/angular-jsdoc/template -r myDir`\n\nRun with gulp-jsdoc\n-------------------\n\n1. install gulp-jsdoc  \n    `$ npm install gulp-shell --save-dev`\n\n2. add the following to the gulpfile.json  \n   ```\n   var shell = require('gulp-shell'); \n   gulp.task('docs', shell.task([ \n     'node_modules/jsdoc/jsdoc.js '+ \n       '-c node_modules/angular-jsdoc/conf.json '+   // config file\n       '-t node_modules/angular-jsdoc/template '+    // template file\n       '-d build/docs '+                             // output directory\n       '-r app/scripts'                              // source code directory\n   ])); \n   ```\n3. run gulp task  \n    `$ gulp docs`\n",
+  "readmeFilename": "README.md",
+  "gitHead": "3c0825da12a70ca5f6bc8c4fa0629d3580847780",
+  "_id": "angular-jsdoc@0.1.1",
+  "_shasum": "5392e150a2db3daf6aa8bbc99caaa07fa076c7ff",
+  "_from": "angular-jsdoc@0.1.1"
 }

README.md

 Angular-JSDoc
 =============
-AngularJS Template for JSDoc 3.  
-A simple collection of JSDoc plugin and template for AngularJS, nothing else!  
+JSDoc 3 Template for AngularJS.  
+A JSDoc plugin and template for AngularJS, nothing else!  
 
+<img src=http://i.imgur.com/FPo9x25.gif width=50%  />
+
 Features
 ----------
-  * Right side table of contents for navigation by Directives, Services, Controllers, etc
+  * Right side TOC, table of contents,  for navigation by Directives, Services, Controllers, etc
   * Read and process @ngdoc tag
@@ -19,4 +21,4 @@
   
-Run
----
+Run In Command Line
+-------------------
 Run jsdoc command to generate your documentation. 
@@ -34,3 +36,3 @@ All command line options are the options of [jsdoc](http://usejsdoc.org/about-commandline.html)
 
-1. install gulp-jsdoc  
+1. install gulp-shell  
     `$ npm install gulp-shell --save-dev`
@@ -46,2 +48,3 @@
        '-d build/docs '+                             // output directory
+       './README.md ' +                              // to include README.md as index contents
        '-r app/scripts'                              // source code directory
@@ -52,1 +55,6 @@ ]));
     `$ gulp docs`
+
+
+[Example of Directive Documentation](https://github.com/allenhwkim/angularjs-google-maps/blob/master/app/scripts/directives/map.js)
+
+[Example of Service Documentation](https://github.com/allenhwkim/angularjs-google-maps/blob/master/app/scripts/services/attr2_options.js)

template/publish.js

@@ -48,2 +48,5 @@ /*global env: true */
     // function and class definitions always get a signature
+   // if (doclet.ngdoc === 'directive') {
+   //     needsSig = false;
+   // } else
     if (doclet.kind === 'function' || doclet.kind === 'class') {
@@ -184,3 +187,4 @@ needsSig = true;
 
-    f.attribs = util.format('<span class="type-signature">%s</span>', attribsString);
+    // I don't think we need attribs, static, inner, etc for Angular JS
+    // f.attribs = util.format('<span class="type-signature">%s</span>', attribsString);
 }
@@ -187,0 +191,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

87692

increased by3.52%

Lines of code

1202

increased by0.08%

Number of lines in readme file

57

increased by16.33%

Dependency changes

• Updatedjsdoc@~3.3.0-alpha11