1.
Installation JS Duck3
tar.gz version
Https://nodeload.github.com/senchalabs/jsduck/tarball/master
EXE version
Http://cloud.github.com/downloads/senchalabs/jsduck/jsduck-3.7.0.exe
Windows users download exe version can be;
EXE version jsduck-3.7.0.exe renamed to Jsduck.exe, added to the environment variable path.
2.
Introduced
The API document Builder for the Sencha JavaScript framework.
Jsduck is used to generate API documentation for EXT JS 4, Sencha Touch and other products.
3.
Usage:
3.1 Generating native class documents directly
Jsduck--builtin-classes--output./docs
3.2 Generating ExtJS source code API documentation
CMD code
- jsduck ext- 4.1.0-beta-3 /src \ --builtin-classes \ --images ext- 4.1. 0-beta-3/ docs/images \ --output ./jsduck/docs
3.3 Creating a project Document
CMD code
- jsduck ext-4.1. 0-beta-3/src/e:/bisoft/code/workspace/project/src/main/webapp/js--builtin-classes/--images ext- 4.1. 0-beta-3/docs/images/--output./jsduck/xdocs
4. Advanced Usage:
Https://github.com/senchalabs/jsduck/wiki/Advanced-Usage
5. Example
The 3.4 version of the API is made as follows:
Download all the contents of version 3.4, unzip and execute:
Jsduck ext-3.4.0/src--builtin-classes--images ext-3.4.0/docs/images--output./jsduck/docs
Note
1, first create the file Jsduck/docs, and then execute the above command. There is a bunch of warnings in the execution that directly ignores
ExtJS Api-js Duck