Proposal to add JSDoc annotations to JavaScript extension points

Development & Design
1

I'm proposing to add JSDoc annotations to the JavaScript extension points(and I'm volenteering to do the work).

I think the discussion is better served over by my illustrative PR over at GitHub but in case extension developers might not see PRs I'm sharing it here as well.

2 Likes
2

Thanks! I think this is a great initiative and I'm happy to help support it. I think it would be helpful to get together a list of existing extension points that should have JSDoc annotations. From what I can tell, these seem like they'd be good candidates for documentation since they're mentioned in the writing extensions documentation:

  • DataTableColumnHeaderUI
  • MenuSystem
  • CellRendererRegistry

Do these make sense as documentation candidates? Are there any others that would be useful for a first-pass at documentation?

3

Yes there are quite a few others, once this proposal is merges I intend to follow up PRs for all of them. Once I'm done the JSDoc annotations themself should be considered the ground truth IMO.

1 Like