DOCS: Improve Mouse & ButtonControl API docs #2080
Merged
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.
Description
Mouse:
DONE -1 for having related links (not recommended for this API type) on current
DONE -1 for insufficient summary length (threshold is 35) each for leftButton, middleButton, rightButton
DONE -1 for using the value tag (not recommended; use the remarks tag instead) each for backButton, clickCount, current, forwardButton, leftButton, middleButton, rightButton, scroll
DONE -2 for insufficient remarks length (threshold is 120) on WarpCursorPosition(Vector2)
DONE -3 for no related links (required for this API type) on Mouse
DONE -4 for missing parameter description for the 'eventPtr' parameter on OnStateEvent(InputEventPtr)
DONE -6 for no code samples (required for this API type) on Mouse
Not done, left for future person:
-4 for no code samples (required for this API type) each for FinishSetup(), MakeCurrent(), OnAdded(), OnNextUpdate(), OnRemoved(), OnStateEvent(InputEventPtr), WarpCursorPosition(Vector2)
-4 for no remarks (required for this API type) each for OnAdded(), OnNextUpdate(), OnRemoved(), OnStateEvent(InputEventPtr)
ButtonControl:
DONE -1 for using the value tag (not recommended; use the remarks tag instead) each for pressPoint, isPressed, pressPointOrDefault, wasPressedThisFrame, wasReleasedThisFrame
DONE -bring back removed links as sentence?
Testing status & QA
No errors on CI
Overall Product Risks
None
Checklist
Before review:
Changed
,Fixed
,Added
sections.Area_CanDoX
,Area_CanDoX_EvenIfYIsTheCase
,Area_WhenIDoX_AndYHappens_ThisIsTheResult
.During merge:
NEW: ___
.FIX: ___
.DOCS: ___
.CHANGE: ___
.RELEASE: 1.1.0-preview.3
.After merge: