angular-jsdoc | AngularJS Template/Plugin for JSDoc | Frontend Framework library
kandi X-RAY | angular-jsdoc Summary
kandi X-RAY | angular-jsdoc Summary
JSDoc 3 Template for AngularJS. A JSDoc plugin and template for AngularJS, nothing else!. Blog: [Sigh, AngularJS Documentation] .
Support
Quality
Security
License
Reuse
Top functions reviewed by kandi - BETA
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of angular-jsdoc
angular-jsdoc Key Features
angular-jsdoc Examples and Code Snippets
Community Discussions
Trending Discussions on angular-jsdoc
QUESTION
Using angular-jsdoc I am using this command to generate my docs
node .\node_modules\jsdoc\jsdoc.js app -c .\node_modules\angular-jsdoc\common\conf.json -d docs -t .\node_modules\angular-jsdoc\angular-template\
I don't prefer typing such long command every-time I update my doc.
I would like to know some shortcut so that I can avoid typing or copy/pasting this command.
...ANSWER
Answered 2017-Feb-09 at 03:14As the command indicates node is being used for execution. I would suggest using npm 's functionality to create project based commands.
This can be done as follows:
- Create a package.json file in your master directory (using npm init).
- Add the below json object in package.json file
"scripts": { "gendoc":"node .\node_modules\jsdoc\jsdoc.js app -c .\node_modules\angular-jsdoc\common\conf.json -d docs -t .\node_modules\angular-jsdoc\angular-template\" }
This will create a gendoc command for your project which can be executed from the command line as follows:
npm run gendoc
Now you don't need to type entire command, just enter the above command, npm will search for the scripts object in package.json and execute the script whose key is gendoc.
Community Discussions, Code Snippets contain sources that include Stack Exchange Network
Vulnerabilities
No vulnerabilities reported
Install angular-jsdoc
Support
Reuse Trending Solutions
Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items
Find more librariesStay Updated
Subscribe to our newsletter for trending solutions and developer bootcamps
Share this Page