Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: Improve Mouse & ButtonControl API docs #2080

Merged
merged 8 commits into from
Dec 10, 2024

Conversation

stefanunity
Copy link
Collaborator

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:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • [*] Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

After merge:

  • Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

@ekcoh ekcoh added the DocsQualityWeek2024 Temporary label for docs week label Dec 6, 2024
@stefanunity stefanunity merged commit f7d9f60 into develop Dec 10, 2024
77 checks passed
@stefanunity stefanunity deleted the docs-quality-week-2024-mouse branch December 10, 2024 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DocsQualityWeek2024 Temporary label for docs week
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants