angular-jsdoc
Advanced tools
Comparing version 1.0.9 to 1.0.10
{ | ||
"name": "angular-jsdoc", | ||
"version": "1.0.9", | ||
"version": "1.0.10", | ||
"description": "JsDoc Plugin and Template for AngularJs", | ||
@@ -11,3 +11,3 @@ "main": "index.js", | ||
"scripts": { | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
"test": "node test.js" | ||
}, | ||
@@ -14,0 +14,0 @@ "author": { |
@@ -7,2 +7,8 @@ Angular-JSDoc | ||
NOTE: the location of configure file and template directory has been moved with the release of 1.0.0 | ||
Please make changes accordingly for your gulp file. | ||
- configure: Old: `node_modules/angular-jsdoc/conf.json` New: `node_modules/angular-jsdoc/common/conf.json` | ||
- template: Old: `node_modules/angular-jsdoc/template` New: `node_modules/angular-jsdoc/default` | ||
Blog: [Sigh, AngularJS Documentation](http://allenhwkim.tumblr.com/post/92161523693/sigh-angularjs-documentation) | ||
@@ -30,2 +36,42 @@ | ||
### With Command Line | ||
// or you can run in command line | ||
$ node_modules/jsdoc/jsdoc.js \ | ||
--configure node_modules/angular-jsdoc/common/conf.json \ | ||
--template node_modules/angular-jsdoc/default \ | ||
--destination build/docs \ | ||
--readme README.md \ | ||
--recurse directives services | ||
### Or, With Gulp | ||
var shell = require('gulp-shell'); | ||
gulp.task('docs', shell.task([ | ||
'node_modules/jsdoc/jsdoc.js '+ | ||
'-c node_modules/angular-jsdoc/common/conf.json '+ // config file | ||
'-t node_modules/angular-jsdoc/default '+ // template file | ||
'-d build/docs '+ // output directory | ||
'./README.md ' + // to include README.md as index contents | ||
'-r directives services' // source code directory | ||
])); | ||
### Or, With Grunt | ||
grunt.initConfig({ | ||
jsdoc : { | ||
dist: { | ||
src: ['directives', 'services'], | ||
options: { | ||
destination: 'build/docs', | ||
configure: 'node_modules/angular-jsdoc/common/conf.json', | ||
template: 'node_modules/angular-jsdoc/default', | ||
readme: './README.md' | ||
} | ||
} | ||
} | ||
}); | ||
### Or, With NodeJS | ||
var angularJsdoc = require('angualr-jsdoc'); | ||
@@ -42,9 +88,2 @@ angularJsdoc(['my-source1', 'my-source2']); | ||
// or you can run in command line | ||
$ node_modules/jsdoc/jsdoc.js \ | ||
--configure node_modules/common/test_conf.json \ | ||
--template node_modules/angular-jsdoc/default \ | ||
--destination docs \ | ||
--readme README.md \ | ||
--recurse sample-codes | ||
@@ -51,0 +90,0 @@ Specification |
@@ -10,1 +10,7 @@ var angularJsdoc = require('./index.js'); | ||
angularJsdoc('sample-codes', { | ||
configure: 'common/test_conf.json', | ||
template: 'html-template', | ||
destination: 'html-template/docs', | ||
readme: "sample-codes/README.md" | ||
}); |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Native code
Supply chain riskContains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.
Found 24 instances in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No tests
QualityPackage does not have any tests. This is a strong signal of a poorly maintained or low quality package.
Found 1 instance in 1 package
4409827
145
8705
1
142
8
49