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 of Menus #1894

Closed abose closed 1 month ago

abose commented 1 month ago

The new doc infrastructure does not work the same as the old docs framework, so made the following changes:

  1. All APIS declared exports.* is the public API and it should come in the docs.
  2. All APIs starting with an _ is a private api, even if its exported, and added @private tag to make it not appear in API docs.
  3. Exported module EVENT_NAME constants should appear in docs.
  4. ENUM declaration for exported named constants to appear in docs.
  5. Some public APIs wont come up in docs if it doesnt have a jsdoc declaration, Eg. see openMenu api in this PR. so added a jsdoc section to missing public APIs to appear in docs.
sonarcloud[bot] commented 1 month 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