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

Improve Component API Doc documentation

Aperta
#137 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
bug
Lingua principale
JavaScript
Stelle
172
Fork
142
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Perhaps this is coming from my inexperience with JSDoc, but I'm getting unexpected results regarding accessibility level in the generated API documentation for my components. Say I have this component:

```js
// my-component.js
import Component from '@ember/component';

/**
* Some new component I made.
*
* @class my-component
* @public
*/
export default Component.extend({
/**
* Some public field
*
* @property publicField
* @type {String}
* @default null
* @public
*/
publicField: null,
});
```

I would expect the public field to be visible by default when the documentation page loads; however, the generated API documentation page for this component looks like this:

![image](https://user-images.githubusercontent.com/5737342/38356056-58d1b608-38c7-11e8-88a1-255a28b9657b.png)

and the public field only becomes visible after clicking the `internal` checkbox:

![image](https://user-images.githubusercontent.com/5737342/38356076-64d2f73c-38c7-11e8-90a7-f10a681ca605.png)

Is there a way to make fields visible as public?

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Riproduci la documentazione API generata dall’esempio my-component.js dell’issue, incluse le annotazioni @public del componente e dei campi. Inizia tracciando il modo in cui la pagina generata applica il proprio filtro del livello di accessibilità, quindi verifica che i campi pubblici siano visibili al caricamento iniziale senza selezionare la casella di controllo interna.

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
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.