docs: update drawTexture typedoc #5641
Merged
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
Fix typedoc warning. [warning] Failed to resolve link to "GraphicsDevice#getCopyShader" in comment for drawTexture.shader. getCopyShader only exists on WebglGraphicsDevice drawTexture only supports WebGL device
The link reference only works if it is not ignored.
mvaligursky
reviewed
Sep 18, 2023
Remove reference, update description.
remove from docs
willeastcott
approved these changes
Sep 19, 2023
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.
This is a small test PR to ensure the process / method is correct.
Addresses warning:
Jsdocs location: pc.drawTexture
Typedocs location: drawTexture
The reference does not exist on GraphicsDevice. On WebglGraphicsDevice, it's marked as ignored so links do not work in jsdocs or typedocs.
This assumes the link should be kept. Removing the "ignore" documents "getCopyShader" in both tools.
Should the "ignore" be honoured and link removed ?
It is documenting the default value.
Notes:
Fixes jsdoc link, typedoc link, removes typedoc warning.
I confirm I have read the contributing guidelines and signed the Contributor License Agreement.