Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refine API docs for files in Utils dir #1917

Closed
wants to merge 3 commits into from

Conversation

devvaannsh
Copy link
Contributor

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.

Copy link
Member

@abose abose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the following missing files/changes too

  • EventDispatcher.js
  • KeyEvent.js - NB: Do not define constants out of the define block, it may break in safari.
  • NativeApp.js
  • NodeUtils.js
  • TokenUtils.js
  • UrlParams.js - not to be included in docs, but add a JS doc comment on top of this file saying that this is deprecated and use browser APIs for operating on URLs.
  • ValidationUtils.js
  • ZipUtils.js

src/utils/EventDispatcher.js Outdated Show resolved Hide resolved
src/utils/ExtensionUtils.js Show resolved Hide resolved
src/utils/NodeConnection.js Show resolved Hide resolved
@devvaannsh
Copy link
Contributor Author

ValidationUtils.js and zipUtils.js files are already added in API docs. The jsdoc for those files seems fine. Doesn't require any changes.

@devvaannsh devvaannsh closed this Oct 29, 2024
Copy link

sonarcloud bot commented Oct 29, 2024

@devvaannsh devvaannsh deleted the utils branch November 1, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants