ember-learn / ember-learn/ember-cli-addon-docs
Improve Component API Doc documentation
- Lenguaje dominante
- JavaScript
- Estrellas
- 172
- Forks
- 142
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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?
Guía de contribución
Línea de trabajo
Reproduce la documentación de API generada a partir del ejemplo my-component.js del issue, incluidas las anotaciones de componente y campo @public. Empieza rastreando cómo la página generada aplica su filtro de nivel de accesibilidad y, a continuación, verifica que los campos públicos sean visibles en la carga inicial sin seleccionar la casilla de verificación interna.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 30/100