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.78k stars 124 forks source link

docs: refine API docs for files in Editor dir #1908

Closed devvaannsh closed 3 weeks ago

devvaannsh commented 3 weeks ago

The following changes are made :

Removed CommandHandler.md from the API docs – This file is removed from API docs, as this in an internal module.

Marked deprecated methods as @private in EditorManager.js – The deprecated methods are now marked as @private to remove them from API docs,

Tweaked jsdoc style comments in Editor.js where required – Changed /** ... */ to /* ... */ so they don’t show up in the API docs. Now, the comments stay in the code without cluttering the docs.

sonarcloud[bot] commented 3 weeks ago

Quality Gate Passed Quality Gate passed

Issues
0 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

devvaannsh commented 3 weeks ago

Updated var to const to resolve the SonarCloud quality gate failure. This change doesn't break any existing code!

abose commented 3 weeks ago

LGTM. Merging.

Thanks for contributing @devvaannsh