Skip to content

Commit e68b246

Browse files
authored
Merge pull request #3588 from thalbern/feature/cref_fixes_docfx
fixed cref errors and removed broken anchor from md file
2 parents ff606cf + 725f33b commit e68b246

File tree

83 files changed

+222
-222
lines changed

Some content is hidden

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

83 files changed

+222
-222
lines changed

Assets/MixedRealityToolkit.Examples/Demos/SpatialAwareness/Scripts/DemoSpatialMeshHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
namespace Microsoft.MixedReality.Toolkit.Examples.Demos
1313
{
1414
/// <summary>
15-
/// This class is an example of the <see cref=" IMixedRealitySpatialAwarenessObservationHandler{T}"/> interface. It keeps track
15+
/// This class is an example of the <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.SpatialAwarenessSystem.Handlers.IMixedRealitySpatialAwarenessObservationHandler{T}"/> interface. It keeps track
1616
/// of the IDs of each mesh and tracks the number of updates they have received.
1717
/// </summary>
1818
public class DemoSpatialMeshHandler : MonoBehaviour, IMixedRealitySpatialAwarenessObservationHandler<SpatialAwarenessMeshObject>

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealitySpatialMeshObserver.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,14 +124,14 @@ public override void Destroy()
124124
private GameObject observedObjectParent = null;
125125

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

131131
private IMixedRealitySpatialAwarenessSystem spatialAwarenessSystem = null;
132132

133133
/// <summary>
134-
/// The currently active instance of <see cref="IMixedRealitySpatialAwarenessSystem"/>.
134+
/// The currently active instance of <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.SpatialAwarenessSystem.IMixedRealitySpatialAwarenessSystem"/>.
135135
/// </summary>
136136
private IMixedRealitySpatialAwarenessSystem SpatialAwarenessSystem => spatialAwarenessSystem ?? (spatialAwarenessSystem = MixedRealityToolkit.SpatialAwarenessSystem);
137137

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
namespace Microsoft.MixedReality.Toolkit.SDK.Audio.Influencers
1111
{
1212
/// <summary>
13-
/// Class which supports components implementing <see cref="IAudioInfluencer"/> being used with audio sources.
13+
/// 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="AudioSource"/> component. If one is not attached, it will be added automatically.
16+
/// AudioInfluencerController requires an <see cref="UnityEngine.AudioSource"/> 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/Audio/Influencers/AudioOccluder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace Microsoft.MixedReality.Toolkit.SDK.Audio.Influencers
99
{
1010
/// <summary>
11-
/// Class that implements <see cref="IAudioInfluencer"/> to provide an audio occlusion effect, similar
11+
/// Class that implements <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.Audio.IAudioInfluencer"/> to provide an audio occlusion effect, similar
1212
/// to listening to sound from outside of an enclosed space.
1313
/// </summary>
1414
/// <remarks>

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

Lines changed: 4 additions & 4 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="GameObject"/>s.
13+
/// Base Component for handling Focus on <see cref="UnityEngine.GameObject"/>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="Component"/>?
23+
/// Is focus enabled for this <see cref="UnityEngine.Component"/>?
2424
/// </summary>
2525
public virtual bool FocusEnabled
2626
{
@@ -29,12 +29,12 @@ public virtual bool FocusEnabled
2929
}
3030

3131
/// <summary>
32-
/// Does this object currently have focus by any <see cref="IMixedRealityPointer"/>?
32+
/// Does this object currently have focus by any <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityPointer"/>?
3333
/// </summary>
3434
public virtual bool HasFocus => FocusEnabled && Focusers.Count > 0;
3535

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public bool DestroyOnSourceLost
4747
public bool IsTracked { get; protected set; } = false;
4848

4949
/// <summary>
50-
/// The current tracking state of the assigned <see cref="IMixedRealityController"/>
50+
/// The current tracking state of the assigned <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.Devices.IMixedRealityController"/>
5151
/// </summary>
5252
protected TrackingState TrackingState = TrackingState.NotTracked;
5353

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="GameObject"/>.
17+
/// Component that allows dragging a <see cref="UnityEngine.GameObject"/>.
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="GameObject"/> and triggers the teleport action.
14+
/// this <see cref="UnityEngine.GameObject"/> 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="GameObject"/> with a <see cref="Collider"/> to Modifies either the <see cref="IMixedRealityCursor"/> reacts when focused by a <see cref="IMixedRealityPointer"/>.
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"/>.
1616
/// </summary>
1717
public class CursorModifier : MonoBehaviour, ICursorModifier
1818
{

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Pointers/BaseControllerPointer.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ public abstract class BaseControllerPointer : ControllerPoseSynchronizer, IMixed
7575
public virtual Vector3 PointerDirection => raycastOrigin != null ? raycastOrigin.forward : transform.forward;
7676

7777
/// <summary>
78-
/// Set a new cursor for this <see cref="IMixedRealityPointer"/>
78+
/// Set a new cursor for this <see cref="Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem.IMixedRealityPointer"/>
7979
/// </summary>
80-
/// <remarks>This <see cref="GameObject"/> must have a <see cref="IMixedRealityCursor"/> attached to it.</remarks>
80+
/// <remarks>This <see cref="UnityEngine.GameObject"/> 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
{
@@ -185,7 +185,7 @@ protected override void OnDisable()
185185

186186
#region IMixedRealityPointer Implementation
187187

188-
/// <inheritdoc cref="IMixedRealityController" />
188+
/// <inheritdoc />
189189
public override IMixedRealityController Controller
190190
{
191191
get { return base.Controller; }

0 commit comments

Comments
 (0)