jsDoc component description

[dsokur]

I'm trying to understand how you guys maintain such a great project. I came across your jsDoc comment for class is this added manually ? I want to adopt this but I can't really figure out how this is working. My assumption is that comments are added manually for properties and the class itself, and then you are using custom-elements-manifest/analyzer to get metadata and build docs based on that metadata. Please help.

/**

• @summary Buttons represent actions that are available to the user.
• @documentation https://shoelace.style/components/button
• @status stable
• @SInCE 2.0
• @dependency sl-icon
• @dependency sl-spinner
• @event sl-blur - Emitted when the button loses focus.
• @event sl-focus - Emitted when the button gains focus.
• @event sl-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
• @slot - The button's label.
• @slot prefix - A presentational prefix icon or similar element.
• @slot suffix - A presentational suffix icon or similar element.
• @csspart base - The component's base wrapper.
• @csspart prefix - The container that wraps the prefix.
• @csspart label - The button's label.
• @csspart suffix - The container that wraps the suffix.
• @csspart caret - The button's caret icon, an <sl-icon> element.
• @csspart spinner - The spinner that shows when the button is in the loading state.
  */
  export default class SlButton extends ShoelaceElement implements ShoelaceFormControl {

[claviska]

Yes, we manually add comments and the analyzer scrapes them into a manifest that we use to generate the site with.

[dsokur]

thanks for a quick reply