Add JSDoc for getters #6685
Merged
Add JSDoc for getters #6685
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kungfooman
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
LeXXik
reviewed
Jun 11, 2024
mvaligursky
reviewed
Jun 11, 2024
mvaligursky
approved these changes
Jun 11, 2024
mvaligursky
pushed a commit
that referenced
this pull request
Jun 12, 2024
MAG-AdrianMeredith
added a commit
to magnopus/playcanvas-engine
that referenced
this pull request
Aug 6, 2024
* Branch 1.71 * GS reorder fix (playcanvas#6409) * Gsplat rendering fix (playcanvas#6590) * [Fix] Add missing exposure handling from the Neutral tonemapping (playcanvas#6592) * Examples app bundle v1 (playcanvas#6594) * treeshake smallest enabled * ignore playcanvas PCUI from being treeshaken * treeshake ignore only pcui * added device type constants directly (no playcanvas dependency) * format rollup * Updated PCUI * removed PCUI aliasing * added publint to ci; removed build:publish (playcanvas#6595) * replaces slashes for windows (playcanvas#6603) * fixed using query params with iframe example (playcanvas#6605) * Fix types for calcAabb functions (playcanvas#6596) * Exports and types fixes v1 (playcanvas#6624) * cleaned up ts and js config; adds debug and profiler to exports * set module resolution to node * Examples config fixes v1 (playcanvas#6627) * added package json for linting of example modules and renamed @examples to examples * fixed missing merge conflict * fixed fallback options (playcanvas#6629) * fixed example types (playcanvas#6635) * adjusted publint error * Fix URL handling in ScriptHandler (playcanvas#6639) (playcanvas#6655) * Particle system uses uint16 indices instead of uint32 (playcanvas#6661) Co-authored-by: Martin Valigursky <[email protected]> * Fix the definition of sheenTint Standard Material property (playcanvas#6665) Co-authored-by: Martin Valigursky <[email protected]> * Update to skybox shader to map it closer to the infinity (playcanvas#6664) Co-authored-by: Martin Valigursky <[email protected]> * Fix shader chunk error for tonemapped compressed GS (playcanvas#6670) * Cherry picked: Add JSDoc for getters (playcanvas#6685) * Gsplat fixes (playcanvas#6710) * GSplat reorder and shader speedup (playcanvas#6715) (playcanvas#6716) * Update setFromMat4 and add tests (playcanvas#6720) * Do not compile different shader for opacity of 1 and diffuse tint of white (playcanvas#6721) Co-authored-by: Martin Valigursky <[email protected]> * Compressed splat update (playcanvas#6746) * Unify gsplat shaders (playcanvas#6753) * Branch 1.72 * Fix gsplat example (playcanvas#6754) * Improve some JSDoc class descriptions (playcanvas#6725) * Improve some JSDoc class descriptions * Lint fixes * Improve GSplatComponent * Remove redundant debugRender from GSplat examples * Improve the Color class description * Leverage WebXR types in public API (playcanvas#6713) * Improve typings and docs for XrPlane (playcanvas#6708) * Improve typing for XrPlane#points * Tweak docs for XrPlane#label * Improve class description * Improve orientation docs * Tweak example source * Correct XrTrackedImage construction docs * Tighten type for XrPlane#orientation * Tweaks to XrAnchor source (playcanvas#6706) * Tweaks to XrAnchor source * More minor docs tweaks * Improve forget docs * Invoke stopPropagation on pointer events handled by gizmo (playcanvas#6770) * [Fix] Stencil clearing was not setting up the mask correctly (playcanvas#6778) * Fix WebXR depth sensing on quest 3 (playcanvas#6774) * Update Tags class to use spread instead of arguments (playcanvas#6775) * Use object destructuring with vectors (playcanvas#6777) * Minor refactor of Curve class (playcanvas#6780) * Minor refactor of Curve class * Tweaks to docs * Gizmo event fix (playcanvas#6790) * Small gizmo event handler fix (playcanvas#6811) * Support for OffscreenCanvas in Web Workers (playcanvas#5167) * Support for OffscreenCanvas in Web Workers playcanvas#2481 * Update graphics-device.js * Update platform.js --------- Co-authored-by: Will Eastcott <[email protected]> * Add gsplat mapping (playcanvas#6824) * array length fix * Branch 1.73 * v1.73.0 * [Fix] Fix albedo debug output (playcanvas#6836) Co-authored-by: Martin Valigursky <[email protected]> * Fix gsplat sorting bug (playcanvas#6845) * v1.73.1 * Small fix to gsplat sorter (playcanvas#6846) * Allow blit to backbuffer (playcanvas#6849) * always assign animation assets to anim component (playcanvas#6863) * getAnimationAsset returns Asset (playcanvas#6864) * fixed getAnimationAsset return to be asset * reverts change as breaking and updates type to match * Update src/framework/components/anim/component-layer.js Co-authored-by: Will Eastcott <[email protected]> * Update src/framework/components/anim/component-layer.js Co-authored-by: Will Eastcott <[email protected]> --------- Co-authored-by: Will Eastcott <[email protected]> * 1.73.2 * v1.73.3 * v1.73.4 * Support for EXT_mesh_gpu_instancing extension (playcanvas#6869) Co-authored-by: Martin Valigursky <[email protected]> --------- Co-authored-by: Donovan Hutchence <[email protected]> Co-authored-by: Martin Valigursky <[email protected]> Co-authored-by: KPal <[email protected]> Co-authored-by: Will Eastcott <[email protected]> Co-authored-by: kpal <[email protected]> Co-authored-by: Mark Lundin <[email protected]> Co-authored-by: Martin Valigursky <[email protected]> Co-authored-by: mrmaxm <[email protected]> Co-authored-by: Michael Franzl <[email protected]> Co-authored-by: Will Eastcott <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #6652
Before:
Any undocumented symbols would be ignored in the API reference by TypeDoc except getters, because we only used to document the setter. This meant that some deliberately undocumented getters were making it into the API.
Now:
TypeDoc is now configured to ignore all undocumented symbols. Even getters. To handle this, this PR documents all getters considered to be part of the API.
This PR also improves on and fixes many formatting issues in the getter/setter API. And we no longer have to hack things to get TypeDoc to generate a valid API reference.
I confirm I have read the contributing guidelines and signed the Contributor License Agreement.