ember-learn / ember-learn/ember-cli-addon-docs
Improve Component API Doc documentation
- Dominant language
- JavaScript
- Stars
- 172
- Forks
- 142
- PR merge metrics
- No merged PRs in 30d
Description
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?
Contributor guide
Assessment
This issue has not been assessed yet.