Merge pull request #3677 from thalbern/user/bethalha/cref_fix

thalbern · web-flow · commit 3f90f85f370b · 2019-03-25T12:21:43.000Z
fixed docfx errors
diff --git a/Assets/MixedRealityToolkit.Examples/Demos/Audio/Scripts/obj.meta b/Assets/MixedRealityToolkit.Examples/Demos/Audio/Scripts/obj.meta
diff --git a/Assets/MixedRealityToolkit.Providers/OpenVR/OpenVRDeviceManager.cs b/Assets/MixedRealityToolkit.Providers/OpenVR/OpenVRDeviceManager.cs
@@ -20,8 +20,8 @@ public class OpenVRDeviceManager : UnityJoystickManager
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
-        /// <param name="spatialAwarenessSystem">The <see cref="IMixedRealitySpatialAwarenessSystem"/> to which the observer is providing data.</param>
+        /// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="spatialAwarenessSystem">The <see cref="Core.Interfaces.SpatialAwarenessSystem.IMixedRealitySpatialAwarenessSystem"/> to which the observer is providing data.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityDeviceManager.cs b/Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityDeviceManager.cs
@@ -23,7 +23,7 @@ public class WindowsMixedRealityDeviceManager : BaseDeviceManager, IMixedReality
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealitySpatialMeshObserver.cs b/Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealitySpatialMeshObserver.cs
@@ -21,7 +21,7 @@ public class WindowsMixedRealitySpatialMeshObserver : BaseSpatialObserver, IMixe
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit.Providers/WindowsVoiceInput/WindowsDictationInputProvider.cs b/Assets/MixedRealityToolkit.Providers/WindowsVoiceInput/WindowsDictationInputProvider.cs
@@ -21,7 +21,7 @@ public class WindowsDictationInputProvider : BaseDeviceManager, IMixedRealityDic
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit.Providers/WindowsVoiceInput/WindowsSpeechInputProvider.cs b/Assets/MixedRealityToolkit.Providers/WindowsVoiceInput/WindowsSpeechInputProvider.cs
@@ -21,7 +21,7 @@ public class WindowsSpeechInputProvider : BaseDeviceManager, IMixedRealitySpeech
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Core.Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit/Attributes/obj.meta b/Assets/MixedRealityToolkit/Attributes/obj.meta
diff --git a/Assets/MixedRealityToolkit/Interfaces/InputSystem/IMixedRealityGazeProvider.cs b/Assets/MixedRealityToolkit/Interfaces/InputSystem/IMixedRealityGazeProvider.cs
@@ -16,7 +16,7 @@ public interface IMixedRealityGazeProvider
         bool Enabled { get; set; }
 
         /// <summary>
-        /// The <see cref="IMixedRealtyInputSystem"/> instance for which this object is providing gaze data.
+        /// The <see cref="IMixedRealityInputSystem"/> instance for which this object is providing gaze data.
         /// </summary>
         IMixedRealityInputSystem InputSystem { set; }
 
diff --git a/Assets/MixedRealityToolkit/Interfaces/Registrars/IMixedRealityServiceRegistrar.cs b/Assets/MixedRealityToolkit/Interfaces/Registrars/IMixedRealityServiceRegistrar.cs
@@ -37,7 +37,7 @@ bool RegisterService<T>(
         /// <summary>
         /// Unregisters a service of the specified type.
         /// </summary>
-        /// <typeparam name="T">The interface type of the service to be unregistered (ex: IMixedRealityBoundarySystem).
+        /// <typeparam name="T">The interface type of the service to be unregistered (ex: IMixedRealityBoundarySystem).</typeparam>
         /// <param name="name">The name of the service to unregister.</param>
         /// <returns>True if the service was successfully unregistered, false otherwise.</returns>
         /// <remarks>If the name argument is not especified, the first instance will be unregistered</remarks>
@@ -46,23 +46,23 @@ bool RegisterService<T>(
         /// <summary>
         /// Unregisters a service.
         /// </summary>
-        /// <typeparam name="T">The interface type of the service to be unregistered (ex: IMixedRealityBoundarySystem).
+        /// <typeparam name="T">The interface type of the service to be unregistered (ex: IMixedRealityBoundarySystem).</typeparam>
         /// <param name="service">The specific service instance to unregister.</param>
         /// <returns>True if the service was successfully unregistered, false otherwise.</returns>
         bool UnregisterService<T>(T serviceInstance) where T : IMixedRealityService;
 
         /// <summary>
         /// Checks to see if a service of the specified type has been registered.
         /// </summary>
-        /// <typeparam name="T">The interface type of the service (ex: IMixedRealityBoundarySystem).
+        /// <typeparam name="T">The interface type of the service (ex: IMixedRealityBoundarySystem).</typeparam>
         /// <param name="name">The name of the service.</param>
         /// <returns>True if the service is registered, false otherwise.</returns>
         bool IsServiceRegistered<T>(string name = null) where T : IMixedRealityService;
 
         /// <summary>
         /// Gets the instance of the registered service.
         /// </summary>
-        /// <typeparam name="T">The interface type of the service (ex: IMixedRealityBoundarySystem).
+        /// <typeparam name="T">The interface type of the service (ex: IMixedRealityBoundarySystem).</typeparam>
         /// <param name="name">The name of the service.</param>
         /// <param name="showLogs">Indicates whether or not diagnostic logging should be performed in case of an error</param>
         /// <returns>The registered service instance as the requested type.</returns>
@@ -71,7 +71,7 @@ bool RegisterService<T>(
         /// <summary>
         /// Gets the collection of the registered service instances matching the requested type.
         /// </summary>
-        /// <typeparam name="T">The interface type of the service (ex: IMixedRealityBoundarySystem).
+        /// <typeparam name="T">The interface type of the service (ex: IMixedRealityBoundarySystem).</typeparam>
         /// <param name="name">Friendly name of the service.</param>
         /// <returns>Read-only collection of the service instances, as the requested type.</returns>
         IReadOnlyList<T> GetServices<T>(string name = null) where T : IMixedRealityService;
@@ -90,7 +90,7 @@ bool RegisterService<T>(
         /// <summary>
         /// Registers a data provider of the specified type.
         /// </summary>
-        /// <typeparam name="T">The interface type of the data provider to be registered.
+        /// <typeparam name="T">The interface type of the data provider to be registered.</typeparam>
         /// <returns>True if the data provider was successfully registered, false otherwise.</returns>
         bool RegisterDataProvider<T>(
             Type concreteType,
@@ -100,7 +100,7 @@ bool RegisterDataProvider<T>(
         /// <summary>
         /// Unregisters a data provider of the specified type.
         /// </summary>
-        /// <typeparam name="T">The interface type of the data provider to be unregistered.
+        /// <typeparam name="T">The interface type of the data provider to be unregistered.</typeparam>
         /// <param name="name">The name of the data provider to unregister.</param>
         /// <returns>True if the data provider was successfully unregistered, false otherwise.</returns>
         /// <remarks>If the name argument is not specified, the first instance will be unregistered</remarks>
@@ -109,31 +109,31 @@ bool RegisterDataProvider<T>(
         /// <summary>
         /// Unregisters a data provider.
         /// </summary>
-        /// <typeparam name="T">The interface type of the data provider to be unregistered.
+        /// <typeparam name="T">The interface type of the data provider to be unregistered.</typeparam>
         /// <param name="service">The specific data provider instance to unregister.</param>
         /// <returns>True if the data provider was successfully unregistered, false otherwise.</returns>
         bool UnregisterDataProvider<T>(T dataProviderInstance) where T : IMixedRealityDataProvider;
 
         /// <summary>
         /// Checks to see if a data provider of the specified type has been registered.
         /// </summary>
-        /// <typeparam name="T">The interface type of the data provider.
+        /// <typeparam name="T">The interface type of the data provider.</typeparam>
         /// <param name="name">The name of the service.</param>
         /// <returns>True if the data provider is registered, false otherwise.</returns>
         bool IsDataProviderRegistered<T>(string name = null) where T : IMixedRealityDataProvider;
 
         /// <summary>
         /// Gets the instance of the registered data provider of the specified type.
         /// </summary>
-        /// <typeparam name="T">The interface type of the data provider.
+        /// <typeparam name="T">The interface type of the data provider.</typeparam>
         /// <param name="name">The name of the data provider.</param>
         /// <returns>The registered data provider instance as the requested type.</returns>
         T GetDataProvider<T>(string name = null) where T : IMixedRealityDataProvider;
 
         /// <summary>
         /// Gets the collection of the registered data provider instances matching the requested type.
         /// </summary>
-        /// <typeparam name="T">The interface type of the data provider.
+        /// <typeparam name="T">The interface type of the data provider.</typeparam>
         /// <param name="name">The name of the data provider.</param>
         /// <returns>Read-only collection of the data provider instances, as the requested type.</returns>
         IReadOnlyList<T> GetDataProviders<T>(string name = null) where T : IMixedRealityDataProvider;
diff --git a/Assets/MixedRealityToolkit/Providers/BaseDeviceManager.cs b/Assets/MixedRealityToolkit/Providers/BaseDeviceManager.cs
@@ -15,7 +15,7 @@ public class BaseDeviceManager : BaseExtensionService, IMixedRealityDeviceManage
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit/Providers/BaseSpatialObserver.cs b/Assets/MixedRealityToolkit/Providers/BaseSpatialObserver.cs
@@ -12,8 +12,8 @@ public class BaseSpatialObserver : BaseDataProvider, IMixedRealitySpatialAwarene
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the observer.</param>
-        /// <param name="spatialAwarenessSystem">The <see cref="IMixedRealitySpatialAwarenessSystem"/> to which the observer is providing data.</param>
+        /// <param name="registrar">The <see cref="Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the observer.</param>
+        /// <param name="spatialAwarenessSystem">The <see cref="Interfaces.SpatialAwarenessSystem.IMixedRealitySpatialAwarenessSystem"/> to which the observer is providing data.</param>
         /// <param name="name">The friendly name of the data provider.</param>
         /// <param name="priority">The registration priority of the data provider.</param>
         /// <param name="profile">The configuration profile for the data provider.</param>
diff --git a/Assets/MixedRealityToolkit/Providers/UnityInput/MouseDeviceManager.cs b/Assets/MixedRealityToolkit/Providers/UnityInput/MouseDeviceManager.cs
@@ -14,7 +14,7 @@ public class MouseDeviceManager : BaseDeviceManager, IMixedRealityExtensionServi
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit/Providers/UnityInput/UnityJoystickManager.cs b/Assets/MixedRealityToolkit/Providers/UnityInput/UnityJoystickManager.cs
@@ -19,7 +19,7 @@ public class UnityJoystickManager : BaseDeviceManager, IMixedRealityExtensionSer
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit/Providers/UnityInput/UnityTouchDeviceManager.cs b/Assets/MixedRealityToolkit/Providers/UnityInput/UnityTouchDeviceManager.cs
@@ -19,7 +19,7 @@ public class UnityTouchDeviceManager : BaseDeviceManager, IMixedRealityExtension
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">Friendly name of the service.</param>
         /// <param name="priority">Service priority. Used to determine order of instantiation.</param>
         /// <param name="profile">The service's configuration profile.</param>
diff --git a/Assets/MixedRealityToolkit/Services/BaseDataProvider.cs b/Assets/MixedRealityToolkit/Services/BaseDataProvider.cs
@@ -5,18 +5,18 @@
 namespace Microsoft.MixedReality.Toolkit
 {
     /// <summary>
-    /// The base data provider implements <see cref="Microsoft.MixedReality.Toolkit.IMixedRealityDataProvider"/> and provides default properties for all data providers.
+    /// The base data provider implements <see cref="Interfaces.IMixedRealityDataProvider"/> and provides default properties for all data providers.
     /// </summary>
     /// <remarks>
-    /// Empty, but reserved for future use, in case additional <see cref="Microsoft.MixedReality.Toolkit.IMixedRealityDataProvider"/> properties or methods are assigned.
+    /// Empty, but reserved for future use, in case additional <see cref="Interfaces.IMixedRealityDataProvider"/> properties or methods are assigned.
     /// </remarks>
     public abstract class BaseDataProvider : BaseExtensionService, IMixedRealityDataProvider
     {
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the data provider.</param>
-        /// <param name="service">The <see cref="IMixedRealityService"/> to which the provider is providing data.</param>
+        /// <param name="registrar">The <see cref="Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the data provider.</param>
+        /// <param name="service">The <see cref="Interfaces.IMixedRealityService"/> to which the provider is providing data.</param>
         /// <param name="name">The friendly name of the data provider.</param>
         /// <param name="priority">The registration priority of the data provider.</param>
         /// <param name="profile">The configuration profile for the data provider.</param>
diff --git a/Assets/MixedRealityToolkit/Services/BaseExtensionService.cs b/Assets/MixedRealityToolkit/Services/BaseExtensionService.cs
@@ -15,7 +15,7 @@ public abstract class BaseExtensionService : BaseService, IMixedRealityExtension
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="registrar">The <see cref="IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
+        /// <param name="registrar">The <see cref="Interfaces.IMixedRealityServiceRegistrar"/> instance that loaded the service.</param>
         /// <param name="name">The friendly name of the service.</param>
         /// <param name="priority">The registration priority of the service.</param>
         /// <param name="profile">The configuration profile for the service.</param>
diff --git a/Assets/MixedRealityToolkit/Utilities/BuildAndDeploy/BuildInfoExtensions.cs b/Assets/MixedRealityToolkit/Utilities/BuildAndDeploy/BuildInfoExtensions.cs
@@ -119,10 +119,10 @@ public static void AppendWithoutConfigurationSymbols(this IBuildInfo buildInfo,
         }
 
         /// <summary>
-        /// Gets the <see cref="BuildTargetGroup"/> for the <see cref="IBuildInfo"/>'s <see cref="BuildTarget"/>
+        /// Gets the <see href="https://docs.unity3d.com/ScriptReference/BuildTargetGroup.html">BuildTargetGroup</see> for the <see cref="IBuildInfo"/>'s <see href="https://docs.unity3d.com/ScriptReference/BuildTarget.html">BuildTarget</see>
         /// </summary>
         /// <param name="buildTarget"></param>
-        /// <returns>The <see cref="BuildTargetGroup"/> for the <see cref="IBuildInfo"/>'s <see cref="BuildTarget"/></returns>
+        /// <returns>The <see href="https://docs.unity3d.com/ScriptReference/BuildTargetGroup.html">BuildTargetGroup</see> for the <see cref="IBuildInfo"/>'s <see href="https://docs.unity3d.com/ScriptReference/BuildTarget.html">BuildTarget</see></returns>
         public static BuildTargetGroup GetGroup(this BuildTarget buildTarget)
         {
             switch (buildTarget)
diff --git a/Assets/MixedRealityToolkit/Utilities/BuildAndDeploy/IBuildInfo.cs b/Assets/MixedRealityToolkit/Utilities/BuildAndDeploy/IBuildInfo.cs
@@ -23,7 +23,7 @@ public interface IBuildInfo
         /// The directory to put the final build output.
         /// </summary>
         /// <remarks>
-        /// Defaults to "<see cref="Application.dataPath"/>/Builds/Platform Target/"
+        /// Defaults to "<see href="https://docs.unity3d.com/ScriptReference/Application-dataPath.html">Application.dataPath</see>/Builds/Platform Target/"
         /// </remarks>
         string OutputDirectory { get; set; }
 
diff --git a/Assets/MixedRealityToolkit/Utilities/BuildAndDeploy/UnityPlayerBuildTools.cs b/Assets/MixedRealityToolkit/Utilities/BuildAndDeploy/UnityPlayerBuildTools.cs
@@ -29,7 +29,7 @@ public static class UnityPlayerBuildTools
         /// Starts the build process
         /// </summary>
         /// <param name="buildInfo"></param>
-        /// <returns>The <see cref="BuildReport"/> from Unity's <see cref="BuildPipeline"/></returns>
+        /// <returns>The <see href="https://docs.unity3d.com/ScriptReference/Build.Reporting.BuildReport.html">BuildReport</see> from Unity's <see href="https://docs.unity3d.com/ScriptReference/BuildPipeline.html">BuildPipeline</see></returns>
         public static BuildReport BuildUnityPlayer(IBuildInfo buildInfo)
         {
             EditorUtility.DisplayProgressBar("Build Pipeline", "Gathering Build Data...", 0.25f);
diff --git a/Assets/MixedRealityToolkit/Utilities/Editor/EditorPreferences.cs b/Assets/MixedRealityToolkit/Utilities/Editor/EditorPreferences.cs
diff --git a/Assets/MixedRealityToolkit/toc.yml b/Assets/MixedRealityToolkit/toc.yml
