ember-learn / ember-learn/ember-cli-addon-docs
Improve Component API Doc documentation
- Vorherrschende Sprache
- JavaScript
- Sterne
- 172
- Forks
- 142
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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?
Beitragsleitfaden
Rechercherichtung
Reproduziere die generierte API-Dokumentation aus dem my-component.js-Beispiel des Issues, einschließlich der @public-Komponenten- und Feldannotationen. Beginne damit nachzuverfolgen, wie die generierte Seite ihren Filter für Zugriffsebenen anwendet, und überprüfe anschließend, dass öffentliche Felder beim ersten Laden sichtbar sind, ohne das Kontrollkästchen für interne Elemente auszuwählen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 30/100