Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softlayer/ember-cli-jsdoc
An Ember CLI addon to generate HTML documentation from JSDoc comments in the source code.
https://github.com/softlayer/ember-cli-jsdoc
Last synced: 3 months ago
JSON representation
An Ember CLI addon to generate HTML documentation from JSDoc comments in the source code.
- Host: GitHub
- URL: https://github.com/softlayer/ember-cli-jsdoc
- Owner: softlayer
- License: mit
- Created: 2015-07-04T15:27:57.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-11T21:55:00.000Z (about 5 years ago)
- Last Synced: 2024-07-07T11:44:47.857Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 445 KB
- Stars: 21
- Watchers: 12
- Forks: 18
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - ember-cli-jsdoc - An Ember.js CLI addon to generate HTML documentation from JSDoc comments in the source code. (Packages / Documentation)
README
[](https://github.com/softlayer/ember-cli-jsdoc/releases)  [](LICENSE.md) [](https://www.npmjs.com/package/ember-cli-jsdoc)
[](https://david-dm.org/softlayer/ember-cli-jsdoc) [](https://david-dm.org/softlayer/ember-cli-jsdoc#info=devDependencies)
# ember-cli-jsdoc
An Ember CLI addon to generate HTML documentation from [JSDoc](http://usejsdoc.org) comments in the source code.
# Install
```sh
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](https://github.com/notmessenger/jsdoc-plugins#emberobservestag) tag
* Automatically populates @listens tag values through use of the [emberListensTag plugin](https://github.com/notmessenger/jsdoc-plugins#emberlistenstag)
* You do not have to employ the @default tag for non-complex types, through the use of the [defaultTag plugin](https://github.com/notmessenger/jsdoc-plugins#defaulttag)
# Things to know
* For the best experience using JSDoc comments you should follow
[this styleguide](https://github.com/softlayer/ember-style-guide#comments).
* 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](http://semver.org/)
# Contribution
[See CONTRIBUTING.md](CONTRIBUTING.md)
# Copyright and License
ember-cli-jsdoc and its source files are Copyright © 2015-2018 [SoftLayer Technologies, Inc.](http://www.softlayer.com/)
The software is [MIT Licensed](LICENSE.md)
# 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.