DOCS: Improved EnhancedTouch.Touch documentation to comply with standards. #2084
Conversation
…ologies/InputSystem into docs-quality-week-2024-touch
| /// | ||
| /// void Update() | ||
| /// { | ||
| /// foreach (var touch in Touch.activeTouches) |
There was a problem hiding this comment.
personally I would have put braces around the content in the foreach loop
There was a problem hiding this comment.
Same here and I see the main example wasn't replaced either (must have accidentally reverted, so I replaced it in coming commit)
| /// the buffer runs out of capacity, older touch entries will get reused. When this happens, | ||
| /// existing <c>Touch</c> instances referring to the record become invalid. | ||
| /// | ||
| /// </para> |
There was a problem hiding this comment.
Does this need/benefit from the separate para sections. I've generally put it into a single one.
There was a problem hiding this comment.
I have gotten xmldoc error any time I mix non-para sections with para sections hence why I have used them since the error message say do not mix para with inline content. Maybe there is something I do not understand about them?
| public bool began => phase == TouchPhase.Began; | ||
|
|
||
| /// <summary> | ||
| /// Whether the touch is currently in progress, i.e. whether <see cref="phase"/> is either |
There was a problem hiding this comment.
I'd be tempted to split some of this into 'remarks' so summary is a bit shorter.
There was a problem hiding this comment.
I think it's fine, it's pretty short when rendered.
| /// </para> | ||
| /// </remarks> | ||
| /// <seealso cref="tapCount"/> | ||
| /// <seealso cref="InputSettings.defaultTapTime"/> |
There was a problem hiding this comment.
might be worth including defaultTapTime in the remarks too
There was a problem hiding this comment.
It already is? See first line in remarks.
…ologies/InputSystem into docs-quality-week-2024-touch
3 participants
Description
Improvements to UnityEngine.InputSystem.EnhancedTouch.Touch based on phase 2 analysis.
-1 for having related links (not recommended for this API type) each for activeFingers, activeTouches, began, delta, displayIndex, ended, finger, fingers, inProgress, isTap, phase, pressure, radius, screenPosition, startScreenPosition, startTime, tapCount, touchId
-1 for insufficient summary length (threshold is 35) each for history, phase, radius
-1 for using the value tag (not recommended; use the remarks tag instead) each for activeFingers, activeTouches, began, delta, displayIndex, ended, finger, fingers, history, inProgress, isInProgress, isTap, maxHistoryLengthPerFinger, phase, pressure, radius, screen, screenPosition, screens, startScreenPosition, startTime, tapCount, time, touchId, valid
-2 for no code samples (required for this API type) each for onFingerDown, onFingerMove, onFingerUp
-2 for no remarks (required for this API type) each for onFingerDown, onFingerMove, onFingerUp
-3 for no related links (required for this API type) on Touch
-4 for missing parameter description for the 'obj' parameter on Equals(object)
-4 for missing parameter description for the 'other' parameter on Equals(Touch)
-4 for no code samples (required for this API type) each for Equals(object), Equals(Touch), GetHashCode(), ToString()
-4 for no remarks (required for this API type) each for Equals(object), Equals(Touch), GetHashCode(), ToString()
-4 for no return values info each for Equals(object), Equals(Touch), GetHashCode(), ToString()
-4 for no summary (required for all apitypes) each for Equals(object), Equals(Touch), GetHashCode(), ToString()
-6 for no code samples (required for this API type) on Touch
Testing status & QA
Please describe the testing already done by you and what testing you request/recommend QA to execute. If you used or created any testing project please link them here too for QA.
Overall Product Risks
Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.
Comments to reviewers
Please describe any additional information such as what to focus on, or historical info for the reviewers.
Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.After merge: