JSDoc 3 template for Controlsjs

• Controlsjs
• Controlsjs on GitHub
• JSDoc3
• JSDoc3 API Documentations

Usage

1. If you want to create documentations with sample files, you can use commands below.

$ npm install
$ grunt demo

2. You can see any output related jsdoc process with a --debug flag.

$ grunt demo --debug

3. If you already have jsdoc system, you can use this project as jsdoc template.

$ jsdoc -t `project folder` -c `configuration file` `source files` `README.md file`

conf.json

You can set options for customizing your documentations.

"templates": {
    "applicationName": "Demo",
    "meta": {
        "title": "",
        "description": "",
        "keyword": ""
    },
    "plugins": [
      "path/to/controlsjs-jsdoc/plugins/controlsjs" //add Controls.js dictionary plugin
    ],
    "sourceLinks": {
      "path/to/src/": "https://github.com/author/app/blob/master/src/%path%#L%lineno%"
    },
    "socialLinks": {
      "AnyName": "",
      "Email": "",
      "Forum": "",
      "Purchase": "",
      "GitHub": "",
      "Twitter": "",
      "Facebook": ""
    }
}

License

This project under the MIT License. and this project refered by default template for JSDoc 3.