Skip to content

Commit 4349ced

Browse files
authored
Merge pull request #3678 from thalbern/feature/more_doc_fix
fixed more doc link errors and added common errors section to dev doc guide
2 parents 3f90f85 + cf6dad4 commit 4349ced

File tree

31 files changed

+66
-73
lines changed

31 files changed

+66
-73
lines changed

Assets/MixedRealityToolkit.Examples/Demos/Audio/Scripts/obj.meta

Lines changed: 0 additions & 8 deletions
This file was deleted.

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

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

Assets/MixedRealityToolkit.Providers/OpenVR/OpenVRDeviceManager.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ public class OpenVRDeviceManager : UnityJoystickManager
2020
/// <summary>
2121
/// Constructor.
2222
/// </summary>
23-
/// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
24-
/// <param name="spatialAwarenessSystem">The <see cref="Core.Interfaces.SpatialAwarenessSystem.IMixedRealitySpatialAwarenessSystem"/> to which the observer is providing data.</param>
23+
/// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
24+
/// <param name="spatialAwarenessSystem">The <see cref="SpatialAwareness.IMixedRealitySpatialAwarenessSystem"/> to which the observer is providing data.</param>
2525
/// <param name="name">Friendly name of the service.</param>
2626
/// <param name="priority">Service priority. Used to determine order of instantiation.</param>
2727
/// <param name="profile">The service's configuration profile.</param>

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityDeviceManager.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public class WindowsMixedRealityDeviceManager : BaseDeviceManager, IMixedReality
2323
/// <summary>
2424
/// Constructor.
2525
/// </summary>
26-
/// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
26+
/// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
2727
/// <param name="name">Friendly name of the service.</param>
2828
/// <param name="priority">Service priority. Used to determine order of instantiation.</param>
2929
/// <param name="profile">The service's configuration profile.</param>

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealitySpatialMeshObserver.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class WindowsMixedRealitySpatialMeshObserver : BaseSpatialObserver, IMixe
2121
/// <summary>
2222
/// Constructor.
2323
/// </summary>
24-
/// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
24+
/// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
2525
/// <param name="name">Friendly name of the service.</param>
2626
/// <param name="priority">Service priority. Used to determine order of instantiation.</param>
2727
/// <param name="profile">The service's configuration profile.</param>

Assets/MixedRealityToolkit.Providers/WindowsVoiceInput/WindowsDictationInputProvider.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class WindowsDictationInputProvider : BaseDeviceManager, IMixedRealityDic
2121
/// <summary>
2222
/// Constructor.
2323
/// </summary>
24-
/// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
24+
/// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
2525
/// <param name="name">Friendly name of the service.</param>
2626
/// <param name="priority">Service priority. Used to determine order of instantiation.</param>
2727
/// <param name="profile">The service's configuration profile.</param>

Assets/MixedRealityToolkit.Providers/WindowsVoiceInput/WindowsSpeechInputProvider.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class WindowsSpeechInputProvider : BaseDeviceManager, IMixedRealitySpeech
2121
/// <summary>
2222
/// Constructor.
2323
/// </summary>
24-
/// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
24+
/// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
2525
/// <param name="name">Friendly name of the service.</param>
2626
/// <param name="priority">Service priority. Used to determine order of instantiation.</param>
2727
/// <param name="profile">The service's configuration profile.</param>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace Microsoft.MixedReality.Toolkit.Input
99
{
1010
/// <summary>
11-
/// This component handles the speech input events raised form the <see cref="Core.Interfaces.InputSystem.IMixedRealityInputSystem"/>.
11+
/// This component handles the speech input events raised form the <see cref="IMixedRealityInputSystem"/>.
1212
/// </summary>
1313
[DisallowMultipleComponent]
1414
public class SpeechInputHandler : BaseInputHandler, IMixedRealitySpeechHandler

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Controllers/MixedRealityControllerVisualizer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace Microsoft.MixedReality.Toolkit.Input
88
/// <summary>
99
/// The Mixed Reality Visualization component is primarily responsible for synchronizing the user's current input with controller models.
1010
/// </summary>
11-
/// <seealso cref="Core.Definitions.Devices.MixedRealityControllerMappingProfile"/>
11+
/// <seealso cref="MixedRealityControllerMappingProfile"/>
1212
public class MixedRealityControllerVisualizer : ControllerPoseSynchronizer, IMixedRealityControllerVisualizer
1313
{
1414
// TODO wire up input actions to controller transform nodes / animations

Assets/MixedRealityToolkit/Attributes/ExtendsAttribute.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace Microsoft.MixedReality.Toolkit
1111
{
1212
/// <summary>
1313
/// Constraint that allows selection of classes that extend a specific class when
14-
/// selecting a <see cref="Microsoft.MixedReality.Toolkit.Utilities.SystemType"/> with the Unity inspector.
14+
/// selecting a <see cref="Utilities.SystemType"/> with the Unity inspector.
1515
/// </summary>
1616
public sealed class ExtendsAttribute : SystemTypeAttribute
1717
{
@@ -24,7 +24,7 @@ public sealed class ExtendsAttribute : SystemTypeAttribute
2424
/// Initializes a new instance of the <see cref="ExtendsAttribute"/> class.
2525
/// </summary>
2626
/// <param name="baseType">Type of class that selectable classes must derive from.</param>
27-
/// <param name="grouping">Gets or sets grouping of selectable classes. Defaults to <see cref="Microsoft.MixedReality.Toolkit.Utilities.TypeGrouping.ByNamespaceFlat"/> unless explicitly specified.</param>
27+
/// <param name="grouping">Gets or sets grouping of selectable classes. Defaults to <see cref="Utilities.TypeGrouping.ByNamespaceFlat"/> unless explicitly specified.</param>
2828
public ExtendsAttribute(Type baseType, TypeGrouping grouping) : base(baseType, grouping)
2929
{
3030
BaseType = baseType;

0 commit comments

Comments
 (0)