ember-learn / ember-learn/ember-cli-addon-docs

Better API doc linking

Abierto
#198 2 comentarios 1 reacción 0 asignados Ver en GitHub
Lenguaje dominante
JavaScript
Estrellas
172
Forks
142
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

[{@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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Usa el ejemplo de JavaScript/JSDoc proporcionado para reproducir la salida de texto plano en la documentación de API Reference. Sigue los puntos de entrada de la generación de API Reference y del renderizado de JSDoc, y verifica después que las formas {@link} mostradas se rendericen como enlaces en lugar de como texto literal.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript
Área
documentation
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.