ember-learn / ember-learn/ember-cli-addon-docs
Better API doc linking
- Lingua principale
- JavaScript
- Stelle
- 172
- Fork
- 142
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
[{@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.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Usa l'esempio JavaScript/JSDoc fornito per riprodurre l'output in testo semplice nella documentazione di API Reference. Traccia i punti di ingresso della generazione di API Reference e del rendering di JSDoc, quindi verifica che le forme {@link} mostrate vengano renderizzate come link anziché come testo letterale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100