ember-learn / ember-learn/ember-cli-addon-docs
Improve Component API Doc documentation
- 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:

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

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