Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ember-cli-jsdoc

softlayer64MIT3.0.0

Generate documentation of your app/addon from your JSDoc comments

ember-addon, jsdoc, documentation, comments, docblock

readme

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-2018 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.

changelog

ember-cli-jsdoc Changelog

3.0.0

BREAKING ENHANCEMENT

  • PR #43 Upgrade Ember CLI to v3.5

View complete changeset

2.0.0

BREAKING ENHANCEMENT

View complete changeset

1.6.0

BUGFIX

INTERNAL

  • #37 Don't add RSVP and Chalk to project devDependencies

View complete changeset

1.5.2

BUGFIX

  • Update addon package dependency version missed in upgrade to chalk 1.1.3 support

View complete changeset

1.5.1

BUGFIX

  • Update addon package dependency version missed in upgrade to JSDoc 3.4.3 support

View complete changeset

1.5.0

BREAKING ENHANCEMENT

  • #33 Upgrade JSDoc dependency to v3.4.3
  • #30 Upgrade Ember CLI to v2.10.0

View complete changeset

1.4.1

BUG FIX

  • #19 and #29 Add missing dependencies

View complete changeset

1.4.0

BREAKING ENHANCEMENT

  • #1 Update JSDoc dependency to 3.4.0

BUG FIX

  • #9 Improve error, warning, and success messages

View complete changeset

1.3.2

BUG FIX

  • #19 Support Node version 5.x.x with correct pathing

View complete changeset

1.3.1

ENHANCEMENT

  • #11 Made this addon OS-independent

View complete changeset

1.3.0

INTERNAL

  • Change to "ember-cli-jsdoc" command to correctly exit on error
  • Provide visually-assistive messsages when errors or warnings occur

View complete changeset

1.2.0

INTERNAL

  • Return call to add NPM package in blueprint
  • Change styling of status message and ensure gets written to UI

View complete changeset

1.1.0

DOCUMENTATION

  • Add badges to README.md

View complete changeset

1.0.0

  • Initial release