docs: refine API docs for files in Utils dir #1917
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Consistent JSDoc Format:
Changed /.../ comments to /**...*/ to maintain consistency and follow the correct JSDoc style.
Public API Documentation:
Added missing JSDoc comments to ensure public APIs are properly documented.
Separate JSDoc for Variables:
In ExtensionLoaded.js, FeatureGate.js, and Resizer.js, each variable is documented separately. This ensures accurate documentation, as only the first function or variable following a JSDoc comment gets picked up. Grouping multiple variables under a single comment causes only the first one to appear in the docs. This change doesn't affect existing code!
Internal Modules Excluded:
Removed EventDispatcher.js and Globals.js from the API docs since they are part of an internal module.