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

Improve Component API Doc documentation

Open
#137 4 comments 0 reactions 0 assignees View on GitHub
bug
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:

![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?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.