Skip to content

Commit 9c825df

Browse files
committed
Fixup documentation
1 parent a5e92ce commit 9c825df

File tree

8 files changed

+25
-18
lines changed

8 files changed

+25
-18
lines changed

Assets/MixedRealityToolkit.Providers/OpenVR/OpenVRDeviceManager.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
namespace Microsoft.MixedReality.Toolkit.OpenVR.Input
1212
{
1313
/// <summary>
14-
/// Manages Open VR Devices using unity's input system.
14+
/// Manages Open VR devices using Unity's input system.
1515
/// </summary>
1616
[MixedRealityDataProvider(
1717
typeof(IMixedRealityInputSystem),

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/XR2018/WindowsMixedRealityArticulatedHand.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
namespace Microsoft.MixedReality.Toolkit.WindowsMixedReality.Input
2828
{
2929
/// <summary>
30-
/// A Windows Mixed Reality Controller Instance.
30+
/// A Windows Mixed Reality articulated hand instance.
3131
/// </summary>
3232
[MixedRealityController(
3333
SupportedControllerType.ArticulatedHand,

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/XRSDK/Controllers/BaseWindowsMixedRealityXRSDKSource.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
namespace Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality
1515
{
1616
/// <summary>
17-
/// A Windows Mixed Reality Source instance.
17+
/// A Windows Mixed Reality source instance.
1818
/// </summary>
1919
public abstract class BaseWindowsMixedRealityXRSDKSource : GenericXRSDKController
2020
{

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/XRSDK/Controllers/WindowsMixedRealityXRSDKArticulatedHand.cs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
using Microsoft.MixedReality.Toolkit.Input;
55
using Microsoft.MixedReality.Toolkit.Utilities;
6-
using Microsoft.MixedReality.Toolkit.WindowsMixedReality;
76
using System;
87
using System.Collections.Generic;
98
using UnityEngine;
109
using UnityEngine.XR;
1110

1211
#if WINDOWS_UWP
12+
using Microsoft.MixedReality.Toolkit.WindowsMixedReality;
1313
using UnityEngine.XR.WindowsMR;
1414
using Windows.Perception.People;
1515
using Windows.UI.Input.Spatial;
@@ -18,12 +18,11 @@
1818
namespace Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality
1919
{
2020
/// <summary>
21-
/// XR SDK implementation of the Windows Mixed Reality motion controllers.
21+
/// XR SDK implementation of Windows Mixed Reality articulated hands.
2222
/// </summary>
2323
[MixedRealityController(
2424
SupportedControllerType.ArticulatedHand,
25-
new[] { Handedness.Left, Handedness.Right },
26-
"StandardAssets/Textures/MotionController")]
25+
new[] { Handedness.Left, Handedness.Right })]
2726
public class WindowsMixedRealityXRSDKArticulatedHand : BaseWindowsMixedRealityXRSDKSource
2827
{
2928
/// <summary>

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/XRSDK/Controllers/WindowsMixedRealityXRSDKMotionController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality
88
{
99
/// <summary>
10-
/// XR SDK implementation of the Windows Mixed Reality motion controllers.
10+
/// XR SDK implementation of Windows Mixed Reality motion controllers.
1111
/// </summary>
1212
[MixedRealityController(
1313
SupportedControllerType.WindowsMixedReality,

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/XRSDK/WindowsMixedRealityDeviceManager.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
namespace Microsoft.MixedReality.Toolkit.XRSDK.WindowsMixedReality
1616
{
1717
/// <summary>
18-
/// Manages Open VR Devices using unity's input system.
18+
/// Manages XR SDK devices on the Windows Mixed Reality platform.
1919
/// </summary>
2020
[MixedRealityDataProvider(
2121
typeof(IMixedRealityInputSystem),

Assets/MixedRealityToolkit.Providers/XRSDK/XRSDKDeviceManager.cs

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
namespace Microsoft.MixedReality.Toolkit.XRSDK.Input
1212
{
1313
/// <summary>
14-
/// Manages Open VR Devices using unity's input system.
14+
/// Manages XR SDK devices.
1515
/// </summary>
1616
[MixedRealityDataProvider(
1717
typeof(IMixedRealityInputSystem),
@@ -35,7 +35,7 @@ public XRSDKDeviceManager(
3535
/// <inheritdoc />
3636
public virtual bool CheckCapability(MixedRealityCapability capability)
3737
{
38-
// The OpenVR platform supports motion controllers.
38+
// The XR SDK platform supports motion controllers.
3939
return (capability == MixedRealityCapability.MotionController);
4040
}
4141

@@ -46,6 +46,7 @@ public virtual bool CheckCapability(MixedRealityCapability capability)
4646
private bool wasLeftInputDeviceValid = false;
4747
private bool wasRightInputDeviceValid = false;
4848

49+
/// <inheritdoc/>
4950
public override void Update()
5051
{
5152
base.Update();
@@ -126,9 +127,9 @@ public override void Update()
126127
#region Controller Utilities
127128

128129
/// <summary>
129-
/// Gets or adds a controller using the joystick name provided.
130+
/// Gets or adds a controller using the InputDevice name provided.
130131
/// </summary>
131-
/// <param name="joystickName">The name of the joystick from Unity's <see href="https://docs.unity3d.com/ScriptReference/Input.GetJoystickNames.html">Input.GetJoystickNames</see></param>
132+
/// <param name="inputDevice">The InputDevice from XR SDK.</param>
132133
/// <returns>The controller reference.</returns>
133134
protected virtual GenericXRSDKController GetOrAddController(InputDevice inputDevice)
134135
{
@@ -188,7 +189,10 @@ protected virtual GenericXRSDKController GetOrAddController(InputDevice inputDev
188189
return detectedController;
189190
}
190191

191-
/// <inheritdoc />
192+
/// <summary>
193+
/// Gets the current controller type for the InputDevice name provided.
194+
/// </summary>
195+
/// <param name="inputDevice">The InputDevice from XR SDK.</param>
192196
protected virtual void RemoveController(InputDevice inputDevice)
193197
{
194198
GenericXRSDKController controller = GetOrAddController(inputDevice);
@@ -210,7 +214,7 @@ protected virtual void RemoveController(InputDevice inputDevice)
210214
/// <summary>
211215
/// Gets the concrete type of the detected controller, based on the <see cref="SupportedControllerType"/> and defined per-platform.
212216
/// </summary>
213-
/// <param name="supportedControllerType">The current controller type from the enum.</param>
217+
/// <param name="supportedControllerType">The current controller type.</param>
214218
/// <returns>The concrete type of the currently detected controller.</returns>
215219
protected virtual Type GetControllerType(SupportedControllerType supportedControllerType)
216220
{
@@ -220,14 +224,18 @@ protected virtual Type GetControllerType(SupportedControllerType supportedContro
220224
/// <summary>
221225
/// Returns the <see cref="InputSourceType"/> of the currently detected controller, based on the <see cref="SupportedControllerType"/>.
222226
/// </summary>
223-
/// <param name="supportedControllerType">The current controller type from the enum.</param>
227+
/// <param name="supportedControllerType">The current controller type.</param>
224228
/// <returns>The enum value of the currently detected controller's InputSource type.</returns>
225229
protected virtual InputSourceType GetInputSourceType(SupportedControllerType supportedControllerType)
226230
{
227231
return InputSourceType.Controller;
228232
}
229233

230-
/// <inheritdoc />
234+
/// <summary>
235+
/// Gets the current controller type for the InputDevice name provided.
236+
/// </summary>
237+
/// <param name="inputDevice">The InputDevice from XR SDK.</param>
238+
/// <returns>The supported controller type.</returns>
231239
protected virtual SupportedControllerType GetCurrentControllerType(InputDevice inputDevice)
232240
{
233241
Debug.Log($"{inputDevice.name} does not have a defined controller type, falling back to generic controller type");

Assets/MixedRealityToolkit/Definitions/Devices/MixedRealityControllerMapping.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ private MixedRealityInteractionMapping[] GetDefaultInteractionMappings()
234234
}
235235

236236
/// <summary>
237-
/// Synchronizes the Input Actions of the same physical controller of a different concrete type.
237+
/// Synchronizes the input actions of the same physical controller of a different concrete type.
238238
/// </summary>
239239
internal void SynchronizeInputActions(MixedRealityInteractionMapping[] otherControllerMapping)
240240
{

0 commit comments

Comments
 (0)