Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ember-learn/ember-cli-addon-docs-yuidoc
https://github.com/ember-learn/ember-cli-addon-docs-yuidoc
ember emberjs hacktoberfest
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ember-learn/ember-cli-addon-docs-yuidoc
- Owner: ember-learn
- License: mit
- Created: 2018-02-23T00:00:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T11:30:48.000Z (6 months ago)
- Last Synced: 2024-04-24T01:41:56.227Z (5 months ago)
- Topics: ember, emberjs, hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 3.94 MB
- Stars: 9
- Watchers: 8
- Forks: 10
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/ember-learn/ember-cli-addon-docs-yuidoc/actions?query=workflow%3ACI)
ember-cli-addon-docs-yuidoc
==============================================================================
[YUIDoc](https://github.com/yui/yuidoc) plugin for Ember CLI Addon Docs. This
plugin adds automatic API documentation to your addon through a modified
version of YUIDoc with support for:
* Modules
* Plain, non-class functions and constants
* Classes
* Added support for accessors and fields
* Components (including arguments and yields)
* Helper functions
* Markdown in comments
Compatibility
------------------------------------------------------------------------------
* Ember.js v3.16 or above
* Ember CLI v2.13 or above
* Node.js v10 or above
Installation
------------------------------------------------------------------------------
```
ember install ember-cli-addon-docs-yuidoc
```
Usage
------------------------------------------------------------------------------
### Documenting a Class
You can document classes using standard YUIDoc syntax with a few modifications
* You can use `@field` as an alias for `@property`
* You can use `@accessor` to reference a native getter/setter, or `@computed`
for an Ember computed. These document the same, but `@computed` assumes a
setter exists, whereas `@accessor` requires you to add the `@set` tag.
* You can add `@static`, `@async`, and `@generator` modifiers to methods
```js
/**
A foo class
@class Foo
@anArbitraryTag
@public
*/
export default class Foo {
/**
A field named foo
@field foo
@type number
*/
foo = 123;
/**
An accessor named baz
@accessor baz
@type any
@set
*/
get bar() {
return this._baz;
}
set bar(val) {
this._baz = val;
}
/**
A static async method named grault
@method grault
@static
@async
*/
static async baz() {
// ...
}
}
```
### Documenting Components
Components can be documented the same as classes, and will be automatically
detected based on folder structure. They also have two extra types of
properties:
* `@yield` which must be applied to the class itself
* `@argument` which is meant to represent an argument passed into the
component
~~~js
/**
A foo-bar component. Usage:
```hbs
{{#foo-bar baz=123 as |hash|}}
{{/foo-bar}}
```
@class FooBarComponent
@yield {Hash} hash
@yield {number} hash.foo
*/
export default Ember.Component.extend({
/**
@argument baz
@type {number}
*/
baz: -1
});
~~~
### Documenting Modules
Modules will automatically be detected - no need to use `@module`. You can use
the following tags:
* `@function` documents plain functions
* `@variable`, `@const`, or `@constant` documents variable values
* `@export [named|default]` specifies the export type
* Classes are considered the default export unless specified otherwise,
functions and variables are considered named unless specified otherwwise.
```js
/**
@class Foo
@export named
*/
export class Foo {}
/**
@function bar
@export default
*/
export default function bar() {}
/**
@const baz
@type {number}
*/
export const baz = 123;
```
Contributing
------------------------------------------------------------------------------
See the [Contributing](CONTRIBUTING.md) guide for details.
License
------------------------------------------------------------------------------
This project is licensed under the [MIT License](LICENSE.md).