Skip to content

Commit c819493

Browse files
fixed remaining cref errors
1 parent cf0c904 commit c819493

30 files changed

+50
-51
lines changed

Assets/MixedRealityToolkit.SDK/Features/Audio/Influencers/AudioInfluencerController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ namespace Microsoft.MixedReality.Toolkit.SDK.Audio.Influencers
1313
/// Class which supports components implementing <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.Audio.IAudioInfluencer"/> being used with audio sources.
1414
/// </summary>
1515
/// <remarks>
16-
/// AudioInfluencerController requires an <see cref="UnityEngine.AudioSource"/> component. If one is not attached, it will be added automatically.
16+
/// AudioInfluencerController requires an <see href="https://docs.unity3d.com/ScriptReference/AudioSource.html">AudioSource</see> component. If one is not attached, it will be added automatically.
1717
/// Each sound playing game object needs to have an AudioInfluencerController attached in order to have it's audio influenced.
1818
/// </remarks>
1919
[RequireComponent(typeof(AudioSource))]

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Cursors/CursorModifier.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
namespace Microsoft.MixedReality.Toolkit.SDK.UX.Cursors
1313
{
1414
/// <summary>
15-
/// Component that can be added to any <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see> with a <see cref="UnityEngine.Collider"/> to Modifies either the <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityCursor"/> reacts when focused by a <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityPointer"/>.
15+
/// Component that can be added to any <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see> with a <see href="https://docs.unity3d.com/ScriptReference/Collider.html">Collider</see> to Modifies either the <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityCursor"/> reacts when focused by a <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityPointer"/>.
1616
/// </summary>
1717
public class CursorModifier : MonoBehaviour, ICursorModifier
1818
{

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Utilities/GazeHandHelper.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
namespace Microsoft.MixedReality.Toolkit.SDK.UX.Utilities
1313
{
1414
/// <summary>
15-
/// This class must be instantiated by a script that implements the <see cref="IMixedRealitySourceStateHandler"/>,
16-
/// <see cref="IMixedRealityInputHandler"/> and <see cref="IMixedRealityInputHandler{T}"/>.
15+
/// This class must be instantiated by a script that implements the <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.Handlers.IMixedRealitySourceStateHandler"/>,
16+
/// <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.Handlers.IMixedRealityInputHandler"/> and <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.Handlers.IMixedRealityInputHandler{T}"/>.
1717
///
1818
/// ***It must receive EventData arguments from OnInputDown(), OnInputUp(), OnInputChanged() and OnSourceLost().***
1919
///
@@ -36,7 +36,7 @@ public class GazeHandHelper
3636
#region Public Methods
3737

3838
/// <summary>
39-
/// This function must be called from the OnInputDown handler in a script implementing the <see cref="IMixedRealityInputHandler{T}"/>.
39+
/// This function must be called from the OnInputDown handler in a script implementing the <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.Handlers.IMixedRealityInputHandler{T}"/>.
4040
/// </summary>
4141
/// <param name="eventData">The InputEventData argument 'eventData' is passed through to GazeHandHelper</param>
4242
public void AddSource(InputEventData eventData)
@@ -56,7 +56,7 @@ public void AddSource(InputEventData eventData)
5656
}
5757

5858
/// <summary>
59-
/// This function must be called from the OnInputUp handler in a script implementing the <see cref="IMixedRealityInputHandler{T}"/>.
59+
/// This function must be called from the OnInputUp handler in a script implementing the <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.Handlers.IMixedRealityInputHandler{T}"/>.
6060
/// </summary>
6161
/// <param name="eventData">he InputEventData argument 'eventData' is passed through to GazeHandHelper</param>
6262
public void RemoveSource(InputEventData eventData)
@@ -84,7 +84,7 @@ public void RemoveSource(SourceStateEventData eventData)
8484
}
8585

8686
/// <summary>
87-
/// This function must be called from the OnInputChanged handler in a script implementing the <see cref="IMixedRealityInputHandler{T}"/>.
87+
/// This function must be called from the OnInputChanged handler in a script implementing the <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.Handlers.IMixedRealityInputHandler{T}"/>.
8888
/// </summary>
8989
/// <param name="eventData"></param>
9090
public void UpdateSource(InputEventData<MixedRealityPose> eventData)

Assets/MixedRealityToolkit/Definitions/InputSystem/MixedRealityInputActionRulesProfile.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public class MixedRealityInputActionRulesProfile : BaseMixedRealityProfile
2929
private InputActionRuleDualAxis[] inputActionRulesDualAxis = null;
3030

3131
/// <summary>
32-
/// All the Input Action Rules for <see cref="UnityEngine.Vector2"/> based <see cref="MixedRealityInputAction"/>s
32+
/// All the Input Action Rules for <see href="https://docs.unity3d.com/ScriptReference/Vector2.html">Vector2</see> based <see cref="MixedRealityInputAction"/>s
3333
/// </summary>
3434
public InputActionRuleDualAxis[] InputActionRulesDualAxis => inputActionRulesDualAxis;
3535

@@ -45,7 +45,7 @@ public class MixedRealityInputActionRulesProfile : BaseMixedRealityProfile
4545
private InputActionRuleQuaternionAxis[] inputActionRulesQuaternionAxis = null;
4646

4747
/// <summary>
48-
/// All the Input Action Rules for <see cref="UnityEngine.Quaternion"/> based <see cref="MixedRealityInputAction"/>s
48+
/// All the Input Action Rules for <see href="https://docs.unity3d.com/ScriptReference/Quaternion.html">Quaternion</see> based <see cref="MixedRealityInputAction"/>s
4949
/// </summary>
5050
public InputActionRuleQuaternionAxis[] InputActionRulesQuaternionAxis => inputActionRulesQuaternionAxis;
5151

Assets/MixedRealityToolkit/Definitions/InputSystem/WindowsGestureSettings.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace Microsoft.MixedReality.Toolkit.Core.Definitions.InputSystem
77
{
88
/// <summary>
9-
/// Copy of Unity's <see cref="UnityEngine.XR.WSA.Input.GestureSettings"/>
9+
/// Copy of Unity's <see href="https://docs.unity3d.com/ScriptReference/XR.WSA.Input.GestureSettings.html">GestureSettings</see>
1010
/// </summary>
1111
[Flags]
1212
public enum WindowsGestureSettings

Assets/MixedRealityToolkit/Definitions/Utilities/AnimatorParameter.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace Microsoft.MixedReality.Toolkit.Core.Definitions.Utilities
88
{
99
/// <summary>
10-
/// A copy of the <see cref="UnityEngine.AnimatorControllerParameter"/> because that class is not Serializable and cannot be modified in the editor.
10+
/// A copy of the <see href="https://docs.unity3d.com/ScriptReference/AnimatorControllerParameter.html">AnimatorControllerParameter</see> because that class is not Serializable and cannot be modified in the editor.
1111
/// </summary>
1212
[Serializable]
1313
public struct AnimatorParameter

Assets/MixedRealityToolkit/Definitions/Utilities/MixedRealityPose.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public MixedRealityPose(Quaternion rotation)
4545
/// The default value for a Six Dof Transform.
4646
/// </summary>
4747
/// <returns>
48-
/// <see cref="UnityEngine.Vector3.zero"/> and <see cref="UnityEngine.Quaternion.identity"/>.
48+
/// <see href="https://docs.unity3d.com/ScriptReference/Vector3-zero.html">Vector3.zero</see> and <see href="https://docs.unity3d.com/ScriptReference/Quaternion-identity.html">Quaternion.identity</see>.
4949
/// </returns>
5050
public static MixedRealityPose ZeroIdentity { get; } = new MixedRealityPose(Vector3.zero, Quaternion.identity);
5151

Assets/MixedRealityToolkit/Definitions/Utilities/TypeGrouping.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public enum TypeGrouping
2626

2727
/// <summary>
2828
/// Group classes in the same way as Unity does for its component menu. This
29-
/// grouping method must only be used for <see cref="UnityEngine.MonoBehaviour"/> types.
29+
/// grouping method must only be used for <see href="https://docs.unity3d.com/ScriptReference/MonoBehaviour.html">MonoBehaviour</see> types.
3030
/// </summary>
3131
ByAddComponentMenu,
3232
}

Assets/MixedRealityToolkit/EventDatum/GenericBaseEventData.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public class GenericBaseEventData : BaseEventData
2828
/// <summary>
2929
/// Constructor.
3030
/// </summary>
31-
/// <param name="eventSystem">Usually <see cref="UnityEngine.EventSystems.EventSystem.current"/></param>
31+
/// <param name="eventSystem">Usually <see href="https://docs.unity3d.com/ScriptReference/EventSystems.EventSystem-current.html">EventSystems.EventSystem.current</see></param>
3232
public GenericBaseEventData(EventSystem eventSystem) : base(eventSystem) { }
3333

3434
/// <summary>

Assets/MixedRealityToolkit/EventDatum/Input/BaseInputEventData.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public abstract class BaseInputEventData : BaseEventData
3939
/// <summary>
4040
/// Constructor.
4141
/// </summary>
42-
/// <param name="eventSystem">Typically will be <see cref="UnityEngine.EventSystems.EventSystem.current"/></param>
42+
/// <param name="eventSystem">Typically will be <see href="https://docs.unity3d.com/ScriptReference/EventSystems.EventSystem-current.html">EventSystems.EventSystem.current</see></param>
4343
protected BaseInputEventData(EventSystem eventSystem) : base(eventSystem) { }
4444

4545
/// <summary>

0 commit comments

Comments
 (0)