# Proposal to add JSDoc annotations to JavaScript extension points

**URL:** <https://forum.openrefine.org/t/proposal-to-add-jsdoc-annotations-to-javascript-extension-points/2284>\
**Category:** Development & Design\
**Created:** [May 7, 2025, 9:44am UTC](https://forum.openrefine.org/t/proposal-to-add-jsdoc-annotations-to-javascript-extension-points/2284 "2025-05-07T09:44:11Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![abbe98](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.openrefine.org/abbe98/32/1299_2.png) [@abbe98](https://forum.openrefine.org/u/abbe98)\
**Post date:** [May 7, 2025, 9:44am UTC](https://forum.openrefine.org/t/proposal-to-add-jsdoc-annotations-to-javascript-extension-points/2284/1 "2025-05-07T09:44:11Z")

</div>

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](https://github.com/OpenRefine/OpenRefine/pull/7296) but in case extension developers might not see PRs I'm sharing it here as well.

---

<div class="post-metadata">

**Author:** ![Rory](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.openrefine.org/rory/32/1517_2.png) [@Rory](https://forum.openrefine.org/u/Rory)\
**Post date:** [May 13, 2025, 3:05pm UTC](https://forum.openrefine.org/t/proposal-to-add-jsdoc-annotations-to-javascript-extension-points/2284/2 "2025-05-13T15:05:10Z")

</div>

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](https://openrefine.org/docs/technical-reference/writing-extensions):

- `DataTableColumnHeaderUI`
- `MenuSystem`
- `CellRendererRegistry`

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

---

<div class="post-metadata">

**Author:** ![abbe98](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.openrefine.org/abbe98/32/1299_2.png) [@abbe98](https://forum.openrefine.org/u/abbe98)\
**Post date:** [May 14, 2025, 8:05am UTC](https://forum.openrefine.org/t/proposal-to-add-jsdoc-annotations-to-javascript-extension-points/2284/3 "2025-05-14T08:05:17Z")

</div>

> [@Rory](#):
>
> Do these make sense as documentation candidates? Are there any others that would be useful for a first-pass at documentation?

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.