Update component to use cem docs #619
rmenner
started this conversation in
Technical Research Documents
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Update
auro-clito latestUpdate package.json
Delete
wcafolder located inscripts. If that is the only folder inscriptsdelete that folder too.Add
@customElementto the JSDOC for any components you want included in the docs, with a brief description of the component aboveAny prop references in the class JSDOC need to be moved down inline with the static property reference.
If the prop accepts specific strings they can be defined like this
If the prop has a default defined in the constructor it will override the JSDOC
@typeused above. Either redefine the type jsdoc in the constructor or move the defined props into a _initializeDefaults() function that can be called in the constructor.Add
custom-elements.jsonto the.gitignoreAdditional Notes
By adding
@forcePrivate {'propName', 'otherProp'}. Properties can be marked private in the cem. As a result not included in the api documentation.If there is a component you don't want included. Add @internal to the JSDOC area of that class.
Beta Was this translation helpful? Give feedback.
All reactions