An Ember CLI addon to generate HTML documentation from JSDoc comments in the source code.
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
addon Initial commit Jul 6, 2015
app Initial commit Jul 6, 2015
blueprints/ember-cli-jsdoc Upgrade jsdoc to 3.5.5 Feb 11, 2018
config Upgrade Ember CLI to v2.10.0 Dec 5, 2016
jsdocTemplates/default Initial commit Jul 6, 2015
lib Changelog entries for v1.6.0 Feb 27, 2017
tests Upgrade Ember CLI to v2.10.0 Dec 5, 2016
vendor Initial commit Jul 6, 2015
.bowerrc Initial commit Jul 6, 2015
.editorconfig Upgrade Ember CLI to v2.7.0 Dec 5, 2016
.ember-cli Initial commit Jul 6, 2015
.gitattributes Closes #15 Mar 23, 2016
.gitignore Upgrade Ember CLI to v2.10.0 Dec 5, 2016
.jshintrc Upgrade Ember CLI to v2.7.0 Dec 5, 2016
.npmignore Upgrade Ember CLI to v2.4.0 Dec 2, 2016
.travis.yml Upgrade Ember CLI to v2.10.0 Dec 5, 2016
.watchmanconfig Upgrade Ember CLI to v1.13.10; has dummy app run errors Dec 2, 2016
ACCEPTED-CLAS.md added juwara0 Mar 1, 2016
CHANGELOG.md Add CHANGELOG entries for v2.0.0 Feb 11, 2018
CLA-CORPORATE.md Initial commit Jul 6, 2015
CLA-INDIVIDUAL.md Initial commit Jul 6, 2015
CONTRIBUTING.md Preparation for removal of develop branch Jul 6, 2015
LICENSE.md Initial commit Jul 6, 2015
README.md Change Ember CLI badge to v2.10.0 Dec 5, 2016
RELEASE-INSTRUCTIONS.md Update release instructions Feb 11, 2018
bower.json Upgrade Ember CLI to v2.10.0 Dec 5, 2016
ember-cli-build.js Upgrade Ember CLI to v2.3.0 Dec 2, 2016
index.js Initial commit Jul 6, 2015
package.json 2.0.0 Feb 11, 2018
testem.js Upgrade Ember CLI to v2.4.0 Dec 2, 2016

README.md

Latest Release Ember CLI version License Downloads

Dependencies Dev Dependencies

ember-cli-jsdoc

An Ember CLI addon to generate HTML documentation from JSDoc comments in the source code.

Install

ember install ember-cli-jsdoc

Use

Run ember ember-cli-jsdoc anytime you wish to generate the documentation. You can then access this generated documentation at http://localhost:4200/docs.

Features

  • Smartly generates jsdoc.json configuration file based on your application or addon's setup
    • You can make any changes to this file as needed to suit your configuration needs
  • Generated documentation is accessible at http://localhost:4200/docs
  • Customized JSDoc template to support display of custom @observes tag
  • Automatically populates @listens tag values through use of the emberListensTag plugin
  • You do not have to employ the @default tag for non-complex types, through the use of the defaultTag plugin

Things to know

  • For the best experience using JSDoc comments you should follow this styleguide.
    • This is because JSDoc does not yet currently fully support ES6 syntax nor does its conventions always reflect the architecture of an Ember application.
  • You may wish to add an entry in your .gitignore file for the /docs folder.
  • If you are using a Node version below 5.x.x you will want to change the plugins entry in the jsdoc.json file to the following:
"plugins": [
    "plugins/markdown",
    "node_modules/ember-cli-jsdoc/node_modules/jsdoc-plugins/plugins/defaultTag",
    "node_modules/ember-cli-jsdoc/node_modules/jsdoc-plugins/plugins/emberListensTag",
    "node_modules/ember-cli-jsdoc/node_modules/jsdoc-plugins/plugins/emberObservesTag"
]

Versioning

Employs Semantic Versioning 2.0.0

Contribution

See CONTRIBUTING.md

Copyright and License

ember-cli-jsdoc and its source files are Copyright © 2015 SoftLayer Technologies, Inc. The software is MIT Licensed

Warranty

This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.