docs(ai): Document enum values in top-level JSDoc comments

Open dlarocque opened this issue 2 months ago • 3 comments

This fixes an issue with the documentation on DevSite, where enum values' JSDoc strings aren't extracted by our API documenter tool. For example, the ImagenPersonFilterLevel docs don't contain docs for each enum value, despite those explanations being in the source code here.

I removed all documentation from the type union declarations (type x = (typeof x..), because 1) they're not used by API documenter so they aren't in devsite, 2) VSCode type hints inherit the docs of the type union from the object: (here we're hovering the definition of a HarmCategory type union, and we see the docs for the HarmCategory object)

Sep 23 '25 16:09 dlarocque

⚠️ No Changeset found

Latest commit: 72961eca1e3a30fe8a38eb5184f3d0834555b3ae

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR