-
Notifications
You must be signed in to change notification settings - Fork 314
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: Added PlayerInput.ActionEvent documentation #2068
DOCS: Added PlayerInput.ActionEvent documentation #2068
Conversation
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
/// The event will be associated with the specified action. The action must be part of an action asset. | ||
/// </remarks> | ||
/// <param name="action">The action to associate with the event. The action must be part of an action asset.</param> | ||
/// <exception cref="ArgumentNullException">The action is null.</exception> |
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.
I believe null should have formatting here?
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.
Should this have ?
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.
Ill add < c > around the null. I assume these whats meant.
I don't understand the '?' query
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
CI errors on docs formatting it seems |
(PlayerInputEditor is internal)
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Show resolved
Hide resolved
Extended summaries, added missing parameters, added some examples, removed non recommended documentation fields (moving some into remarks as recommended)
…ub.com:Unity-Technologies/InputSystem into docs-quality-week-2024-playerinput-actionevent
Fixed formatting, addressed a whole load more documentation issues from the low score on the documentation assessment. |
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs
Outdated
Show resolved
Hide resolved
/// <remarks> | ||
/// <example> | ||
/// <code> | ||
/// PlayerInput player = PlayerInput.GetPlayerByIndex(0); |
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.
Are we ok with non-compilable examples? @duckets
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.
It should compile but not in isolation. I'll await doc writer feedback
/// | ||
/// <example> | ||
/// <code> | ||
/// PlayerInput.all[0].SwitchCurrentActionMap("Player"); |
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.
Similar comment as previously on non-compilable example
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.
It should compile but not in isolation. I'll await doc writer feedback
Still has similar errors in CI as my branch (See dry-run target): PVP-150-1: UnityEngine.InputSystem.PlayerInput: onActionTriggered: in block context (only allowed in top-level context) |
I've fixed these. Several were already there but I've tided it up. |
… than nested in 'remarks')
Description
Added PlayerInput.ActionEvent documentation
Updated PlayerInput documentation to improve, adding missing parameters, adding some examples, moving some see also links into the remarks as part of explanations.
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: