Skip to content

Commit f212c32

Browse files
authored
Merge pull request #3598 from thalbern/feature/cref_fixes_unity
replaced unity crefs with links to api docs, fixed remaining crefs
2 parents 998c494 + c819493 commit f212c32

File tree

60 files changed

+138
-139
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+138
-139
lines changed

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealitySpatialMeshObserver.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ public override void Destroy()
124124
private GameObject observedObjectParent = null;
125125

126126
/// <summary>
127-
/// The <see cref="UnityEngine.GameObject"/> to which observed objects are parented.
127+
/// The <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see> to which observed objects are parented.
128128
/// </summary>
129129
private GameObject ObservedObjectParent => observedObjectParent != null ? observedObjectParent : (observedObjectParent = SpatialAwarenessSystem?.CreateSpatialAwarenessObjectParent("WindowsMixedRealitySpatialMeshObserver"));
130130

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/Input/Handlers/BaseFocusHandler.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
namespace Microsoft.MixedReality.Toolkit.SDK.Input.Handlers
1111
{
1212
/// <summary>
13-
/// Base Component for handling Focus on <see cref="UnityEngine.GameObject"/>s.
13+
/// Base Component for handling Focus on <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see>s.
1414
/// </summary>
1515
[RequireComponent(typeof(Collider))]
1616
public abstract class BaseFocusHandler : MonoBehaviour, IMixedRealityFocusHandler
@@ -20,7 +20,7 @@ public abstract class BaseFocusHandler : MonoBehaviour, IMixedRealityFocusHandle
2020
private bool focusEnabled = true;
2121

2222
/// <summary>
23-
/// Is focus enabled for this <see cref="UnityEngine.Component"/>?
23+
/// Is focus enabled for this <see href="https://docs.unity3d.com/ScriptReference/Component.html">Component</see>?
2424
/// </summary>
2525
public virtual bool FocusEnabled
2626
{
@@ -34,7 +34,7 @@ public virtual bool FocusEnabled
3434
public virtual bool HasFocus => FocusEnabled && Focusers.Count > 0;
3535

3636
/// <summary>
37-
/// The list of <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityPointer"/>s that are currently focused on this <see cref="UnityEngine.GameObject"/>
37+
/// The list of <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityPointer"/>s that are currently focused on this <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see>
3838
/// </summary>
3939
public List<IMixedRealityPointer> Focusers { get; } = new List<IMixedRealityPointer>(0);
4040

Assets/MixedRealityToolkit.SDK/Features/Input/Handlers/DragAndDropHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
namespace Microsoft.MixedReality.Toolkit.SDK.Input.Handlers
1515
{
1616
/// <summary>
17-
/// Component that allows dragging a <see cref="UnityEngine.GameObject"/>.
17+
/// Component that allows dragging a <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see>.
1818
/// Dragging is done by calculating the angular delta and z-delta between the current and previous hand positions,
1919
/// and then repositioning the object based on that.
2020
/// </summary>

Assets/MixedRealityToolkit.SDK/Features/Input/Handlers/TeleportHotSpot.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace Microsoft.MixedReality.Toolkit.SDK.Input.Handlers
1111
{
1212
/// <summary>
1313
/// SDK component handling teleportation to a specific position &amp; orientation when a user focuses
14-
/// this <see cref="UnityEngine.GameObject"/> and triggers the teleport action.
14+
/// this <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see> and triggers the teleport action.
1515
/// </summary>
1616
public class TeleportHotSpot : BaseFocusHandler, IMixedRealityTeleportHotSpot
1717
{

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 cref="UnityEngine.GameObject"/> 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/Pointers/BaseControllerPointer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public abstract class BaseControllerPointer : ControllerPoseSynchronizer, IMixed
7777
/// <summary>
7878
/// Set a new cursor for this <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityPointer"/>
7979
/// </summary>
80-
/// <remarks>This <see cref="UnityEngine.GameObject"/> must have a <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityCursor"/> attached to it.</remarks>
80+
/// <remarks>This <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see> must have a <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityCursor"/> attached to it.</remarks>
8181
/// <param name="newCursor">The new cursor</param>
8282
public virtual void SetCursor(GameObject newCursor = null)
8383
{

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.SDK/Features/UX/Scripts/Utilities/InteractableHighlight.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
namespace Microsoft.MixedReality.Toolkit.SDK.UX.Utilities
1111
{
1212
/// <summary>
13-
/// Adds or removes materials to target renderer for highlighting Focused <see cref="UnityEngine.GameObject"/>s.
14-
/// <remarks>Useful with focusable <see cref="UnityEngine.GameObject"/>s</remarks>
13+
/// Adds or removes materials to target renderer for highlighting Focused <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see>s.
14+
/// <remarks>Useful with focusable <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see>s</remarks>
1515
/// </summary>
1616
public class InteractableHighlight : BaseFocusHandler
1717
{

Assets/MixedRealityToolkit.SDK/Features/Utilities/Solvers/Solver.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public abstract class Solver : MonoBehaviour
4444
private float currentLifetime;
4545

4646
/// <summary>
47-
/// The handler reference for this solver that's attached to this <see cref="UnityEngine.GameObject"/>
47+
/// The handler reference for this solver that's attached to this <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see>
4848
/// </summary>
4949
[SerializeField]
5050
[HideInInspector]

0 commit comments

Comments
 (0)