ember-learn / ember-learn/ember-cli-addon-docs
Better API doc linking
- Dominant language
- JavaScript
- Stars
- 172
- Forks
- 142
- PR merge metrics
- No merged PRs in 30d
Description
[{@link}](http://usejsdoc.org/tags-inline-link.html) tag renders as plain text in API Reference documentation.
For example:
```js
/**
* My Addon Function
*
* {@link https://ember-learn.github.io/ember-cli-addon-docs/}
*
* [ember-cli-addon-docs]{@link https://ember-learn.github.io/ember-cli-addon-docs/}
*
* {@link https://ember-learn.github.io/ember-cli-addon-docs/|ember-cli-addon-docs}
*
* {@link https://ember-learn.github.io/ember-cli-addon-docs/ ember-cli-addon-docs}
*
* @function myFunction
* @returns {Boolean} True.
*/
export default function myFunction() {
return true;
}
```
renders as:
```
myFunction(): boolean
My Addon Function
{@link https://ember-learn.github.io/ember-cli-addon-docs/}
[ember-cli-addon-docs]{@link https://ember-learn.github.io/ember-cli-addon-docs/}
{@link https://ember-learn.github.io/ember-cli-addon-docs/|ember-cli-addon-docs}
{@link https://ember-learn.github.io/ember-cli-addon-docs/ ember-cli-addon-docs}
```
I reference another project I borrowed code from and want to link back to it.
Contributor guide
Assessment
This issue has not been assessed yet.