-
Notifications
You must be signed in to change notification settings - Fork 317
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: Updated InputControl documentation #2078
Conversation
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of missing docs added, great you adressed this. Have a bunch of minor comments to address.
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Controls/InputControl.cs
Outdated
Show resolved
Hide resolved
/// </summary> | ||
/// <remarks> | ||
/// Return a string representation of the control. Useful for debugging. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this or , shouldn't be different than object.ToString right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure I understand this query. Agreed its no different. Are you suggesting use inheritdoc ?
not sure that works if its not in the same file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes that was what I suggested, sorry if it was unclear.
Description
Updated InputControl documentation
Testing status & QA
Reviewed generated docs using the DocTools package and checked the validation results
Overall Product Risks
Comments to reviewers
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: