0.1.8 • Published 8 years ago
modoc v0.1.8
modoc
An API documentation generator
Install and Run
npm
npm install modoc -g
modoc --config <configPath>
github
git clone https://github.com/mhbseal/modoc.git
cd modoc && npm install
node modoc.js --config <configPath>
Example
source contains mojs examplehttp://mhbseal.com/api/mojs.html ,so wen can Enter 'exmpale' directory after install(npm or github)
npm
modoc
github
node ../modoc
Config
{
"name": "",
"version": "",
"repositoryUrl": "",
"introduction": "",
"paths": {
"input": "",
"output": ""
},
"source": "",
"skip": []
}
Comment Example
general document comment
/**
* description
*
* @param {string} 1
* @param {object} 2
* - a {number} 3
* - b {string} 4
* @param {function} 5
* - param {number} 6
* - param {function} 7
* - param 8
* @return {object} 9
* - c {string} 10
* - d {number} 11
*/
after add generator
/**
* description
*
* @param {string} 1
* @param {object} 2
* - a {number} 3
* - b {string} 4
* @param {function} 5
* - param {number} 6
* - param {function} 7
* - param 8
* @return {object} 9
* - c {string} 10
* - d {number} 11
*
* @name file name or method name or property name(required)
* @example
* var str = 'modoc';
* num.toUpperCase();
* ...
* @more
* this is more information,
* modoc is very good.
* ...
*/
0.1.8
8 years ago
0.1.7-rc1
8 years ago
0.1.7
8 years ago
0.1.6-rc1
8 years ago
0.1.6
8 years ago
0.1.5
9 years ago
0.1.4
9 years ago
0.1.3
9 years ago
0.1.2
9 years ago
0.1.1-rc
9 years ago
0.2.1
9 years ago
0.1.0-rc.1.2
9 years ago
0.1.0-rc.1.1
9 years ago
4.0.0
9 years ago
3.0.0
9 years ago
0.0.3
9 years ago
0.0.2
9 years ago
0.0.1
9 years ago
0.1.1
9 years ago
0.2.0
9 years ago
1.0.0
9 years ago
0.1.0
9 years ago