search

phcode-dev / phoenix

Phoenix is a modern open-source Code Editor for the web, built for the browser.
https://phcode.io
GNU Affero General Public License v3.0
1.79k stars 124 forks source link

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

Closed devvaannsh closed 4 weeks ago

devvaannsh commented 1 month ago

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.

devvaannsh commented 4 weeks ago

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

sonarcloud[bot] commented 4 weeks ago

Quality Gate Passed Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud