Info
It would be extremely beneficial to developers using our component wrappers to see better descriptions of properties in components. This would better allow them to stay in their IDE instead of having to switch between IDE and documentation website to figure out what they want to do.
Just a normal comment on a property:
A proper full JSDoc comment on that same property:
As you can see above, with just that one property. It properly gives a description of the property, what type of data it allows for (this can be expanded even further by documenting that type properly as well), whether it's optional or required, and what the default value is so they know.
We only need to create the comments for either Angular or React wrappers, and then have a script to copy them to other set of wrappers.
Acceptance Criteria:
- Give proper full JSDoc comments for every property and event in every component, in either Angular or React
- Use AI to duplicate to either Angular or React
Info
It would be extremely beneficial to developers using our component wrappers to see better descriptions of properties in components. This would better allow them to stay in their IDE instead of having to switch between IDE and documentation website to figure out what they want to do.
Just a normal comment on a property:
A proper full JSDoc comment on that same property:
As you can see above, with just that one property. It properly gives a description of the property, what type of data it allows for (this can be expanded even further by documenting that type properly as well), whether it's optional or required, and what the default value is so they know.
We only need to create the comments for either Angular or React wrappers, and then have a script to copy them to other set of wrappers.
Acceptance Criteria: