Fixing summary/remarks block errors in MRTK3 code base (#11654)

Fixing summary/remarks block errors

com.microsoft.mrtk.core/Configuration/MRTKProfile.cs

@@ -46,7 +46,7 @@ public static MRTKProfile Instance
         protected SerializableDictionary<SystemType, BaseSubsystemConfig> subsystemConfigs = new SerializableDictionary<SystemType, BaseSubsystemConfig>();
 
         /// <summary>
-        /// Attempts to retrieve the specified <see cref="BaseSubsystemConfig"> for a given subsystem type.
+        /// Attempts to retrieve the specified <see cref="BaseSubsystemConfig"/> for a given subsystem type.
         /// </summary>
         /// <returns>
         /// True if there is a registered configuration for the specified subsystem. False otherwise.

com.microsoft.mrtk.core/Interactables/IScrollable.cs

@@ -7,8 +7,8 @@
 namespace Microsoft.MixedReality.Toolkit
 {
     /// <summary>
-    /// A Unity <see href="https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.3/api/UnityEngine.XR.Interaction.Toolkit.IXRInteractable.html">IXRInteractable</see>
-    /// that is capable of being scrolled by a Unity <see href="https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.3/api/UnityEngine.XR.Interaction.Toolkit.IXRInteractor.html">IXRInteractor</see>.
+    /// A Unity <see href="https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%402.3/api/UnityEngine.XR.Interaction.Toolkit.IXRInteractable.html">IXRInteractable</see>
+    /// that is capable of being scrolled by a Unity <see href="https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%402.3/api/UnityEngine.XR.Interaction.Toolkit.IXRInteractor.html">IXRInteractor</see>.
     /// </summary>
     public interface IScrollable : IXRInteractable
     {
@@ -23,7 +23,7 @@ public interface IScrollable : IXRInteractable
         bool IsScrolling { get; }
 
         /// <summary>
-        /// Get the Unity <see href="https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.0/api/UnityEngine.XR.Interaction.Toolkit.IXRInteractor.html"">IXRInteractor</see>
+        /// Get the Unity <see href="https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit%402.0/api/UnityEngine.XR.Interaction.Toolkit.IXRInteractor.html"">IXRInteractor</see>
         /// that is scrolling or will scroll the specified <see cref="ScrollableTransform"/>.
         /// </summary>
         IXRInteractor ScrollingInteractor { get; }

com.microsoft.mrtk.core/Interactables/MRTKBaseInteractable.cs

@@ -20,7 +20,7 @@ public class MRTKBaseInteractable : XRBaseInteractable
         readonly List<IGazeInteractor> hoveringGazeInteractors = new List<IGazeInteractor>();
 
         /// <summary>
-        /// (Read Only) The list of <see cref="IGazeInteractor">s currently gazing this object.
+        /// (Read Only) The list of <see cref="IGazeInteractor"/> components currently gazing this object.
         /// </summary>
         public List<IGazeInteractor> HoveringGazeInteractors => hoveringGazeInteractors;
 
@@ -31,14 +31,14 @@ public class MRTKBaseInteractable : XRBaseInteractable
         readonly List<IGazePinchInteractor> hoveringGazePinchInteractors = new List<IGazePinchInteractor>();
 
         /// <summary>
-        /// (Read Only) The list of <see cref="IGazePinchInteractor">s currently hovering this object.
+        /// (Read Only) The list of <see cref="IGazePinchInteractor"/> components currently hovering this object.
         /// </summary>
         public List<IGazePinchInteractor> HoveringGazePinchInteractors => hoveringGazePinchInteractors;
 
         readonly List<IGazePinchInteractor> selectingGazePinchInteractors = new List<IGazePinchInteractor>();
 
         /// <summary>
-        /// (Read Only) The list of <see cref="IGazePinchInteractor">s currently selecting this object.
+        /// (Read Only) The list of <see cref="IGazePinchInteractor"/> components currently selecting this object.
         /// </summary>
         public List<IGazePinchInteractor> SelectingGazePinchInteractors => selectingGazePinchInteractors;
 
@@ -49,7 +49,7 @@ public class MRTKBaseInteractable : XRBaseInteractable
         readonly List<IPokeInteractor> hoveringPokeInteractors = new List<IPokeInteractor>();
 
         /// <summary>
-        /// (Read Only) The list of PokeInteractors currently hovering this object.
+        /// (Read Only) The list of <see cref="IPokeInteractor"/> components currently hovering this object.
         /// </summary>
         public List<IPokeInteractor> HoveringPokeInteractors => hoveringPokeInteractors;
 
@@ -60,14 +60,14 @@ public class MRTKBaseInteractable : XRBaseInteractable
         readonly List<IGrabInteractor> hoveringGrabInteractors = new List<IGrabInteractor>();
 
         /// <summary>
-        /// (Read Only) The list of XRRayInteractors (hand rays) currently hovering this object.
+        /// (Read Only) The list of <see cref="IGrabInteractor"/> components currently hovering this object.
         /// </summary>]
         public List<IGrabInteractor> HoveringGrabInteractors => hoveringGrabInteractors;
 
         readonly List<IGrabInteractor> selectingGrabInteractors = new List<IGrabInteractor>();
 
         /// <summary>
-        /// (Read Only) The list of <see cref="IGrabInteractor">s currently selecting this object.
+        /// (Read Only) The list of <see cref="IGrabInteractor"/> components currently selecting this object.
         /// </summary>
         public List<IGrabInteractor> SelectingGrabInteractors => selectingGrabInteractors;
 
@@ -78,7 +78,7 @@ public class MRTKBaseInteractable : XRBaseInteractable
         readonly List<IRayInteractor> hoveringRayInteractors = new List<IRayInteractor>();
 
         /// <summary>
-        /// (Read Only) The list of XRRayInteractors (hand rays) currently hovering this object.
+        /// (Read Only) The list of <see cref="IRayInteractor"/> components currently hovering this object.
         /// </summary>]
         public List<IRayInteractor> HoveringRayInteractors => hoveringRayInteractors;
 

com.microsoft.mrtk.core/Interactables/StatefulInteractable.cs

@@ -228,7 +228,7 @@ protected override void OnDestroy()
         /// Derived classes should override this method to
         /// specify custom variable selection math.
         /// The default implementation allows for variable selection
-        /// from the <see cref="GazePinchInteractor">, calculated with
+        /// from the <see cref="GazePinchInteractor"/>, calculated with
         /// <see cref="PinchAmount"/>.
         /// </summary>
         public virtual float Selectedness()

com.microsoft.mrtk.core/Interactors/IProxyInteractor.cs

@@ -10,41 +10,43 @@ namespace Microsoft.MixedReality.Toolkit
     /// The abstract interaction events that all proxy interactors support.
     /// Proxy interactors are used to map foreign interaction systems (like UnityUI)
     /// onto XRI interaction primitives.
+    /// </summary>
+    /// <remarks>
     /// Generally, input shims will call these functions to request the proxy to
     /// hover/select/etc the object on which the shim is placed.
-    /// </summary>
+    /// </remarks>
     public interface IProxyInteractor : IXRSelectInteractor, IXRHoverInteractor
     {
         /// <summary>
         /// Begin hovering the interactable. The interactable will receive
-        /// an OnHoverEntering/Entered, and the proxy interactor will include it in
+        /// <c>OnHoverEntering</c> and <c>OnHoverEntered</c> events, and the proxy interactor will include it in
         /// its list of valid targets.
         /// </summary>
         void StartHover(IXRHoverInteractable interactable);
 
         /// <summary>
         /// Begin hovering the interactable. The interactable will receive
-        /// an OnHoverEntering/Entered, and the proxy interactor will include it in
+        /// <c>OnHoverEntering</c> and <c>OnHoverEntered</c> events, and the proxy interactor will include it in
         /// its list of valid targets. Also includes the worldPosition of the pointer.
         /// </summary>
         void StartHover(IXRHoverInteractable interactable, Vector3 worldPosition);
 
         /// <summary>
         /// End hovering the interactable. The interactable will receive
-        /// an OnHoverExiting/Exited, and the proxy interactor will remove it from
+        /// <c>OnHoverExiting</c> and <c>OnHoverExited</c> events, and the proxy interactor will remove it from
         /// its list of valid targets.
         /// </summary>
         void EndHover(IXRHoverInteractable interactable);
 
         /// <summary>
         /// Begin selecting the interactable. The interactable will receive
-        /// an OnSelectEntering/Entered.
+        /// <c>OnSelectEntering</c> and <c>OnSelectEntered</c> events.
         /// </summary>
         void StartSelect(IXRSelectInteractable interactable);
 
-        // <summary>
+        /// <summary>
         /// Begin selecting the interactable. The interactable will receive
-        /// an OnSelectEntering/Entered. Also includes the worldPosition of the pointer.
+        /// <c>OnSelectEntering</c> and <c>OnSelectEntered</c> events. Also includes the worldPosition of the pointer.
         /// </summary>
         void StartSelect(IXRSelectInteractable interactable, Vector3 worldPosition);
 
@@ -56,7 +58,7 @@ public interface IProxyInteractor : IXRSelectInteractor, IXRHoverInteractor
 
         /// <summary>
         /// End selecting the interactable. The interactable will receive
-        /// an OnSelectExiting/Exited. SuppressEvents will prevent StatefulInteractables
+        /// <c>OnSelectExiting</c> and <c>OnSelectExited</c> events. SuppressEvents will prevent StatefulInteractables
         /// from receiving click or toggle events.
         /// </summary>
         void EndSelect(IXRSelectInteractable interactable, bool suppressEvents = false);

com.microsoft.mrtk.core/Subsystems/Hands/HandsAggregatorSubsystem.cs

@@ -13,9 +13,10 @@ namespace Microsoft.MixedReality.Toolkit.Subsystems
     /// Subsystem for aggregating skeletal hand joint data from all available sources.
     /// Implementations can aggregate hand joint data from multiple APIs, or from multiple
     /// HandsSubsystems, or from any other source they choose.
-    /// Recommended use is for aggregating from all loaded HandsSubsystems.
-    /// See <cref see="MRTKHandsAggregatorSubsystem"> for the MRTK implementation.
     /// </summary>
+    /// <remarks>
+    /// Recommended use is for aggregating from all loaded HandsSubsystems. See <cref see="MRTKHandsAggregatorSubsystem" /> for the MRTK implementation.
+    /// </remarks>
     [Preserve]
     public class HandsAggregatorSubsystem :
         MRTKSubsystem<HandsAggregatorSubsystem,

com.microsoft.mrtk.core/Subsystems/Hands/IHandsAggregatorSubsystem.cs

@@ -13,37 +13,36 @@ namespace Microsoft.MixedReality.Toolkit.Subsystems
     /// Both the HandsAggregatorSubsystem implementation and the associated provider
     /// MUST implement this interface, preferably with a direct 1:1 mapping
     /// between the provider surface and the subsystem surface.
+    /// </summary>
     /// <remarks>
     /// HandsAggregators aggregate skeletal hand joint data from all available sources.
     /// Implementations can aggregate hand joint data from multiple APIs, or from multiple
     /// HandsSubsystems, or from any other source they choose.
     /// Recommended use is for aggregating from all loaded HandsSubsystems.
-    /// See <see cref="MRTKHandsAggregatorSubsystem"> for the MRTK implementation.
+    /// See <see cref="MRTKHandsAggregatorSubsystem"/> for the MRTK implementation.
     /// </remarks>
-    /// </summary>
     public interface IHandsAggregatorSubsystem : ISubsystem
     {
         /// <summary>
-        /// The playspace-local pose of the near interaction point.
+        /// The play space local pose of the near interaction point.
         /// This will be the index finger tip of a fully tracked articulated hand,
         /// or a best estimate of the equivalent location when less information is
         /// available on the platform.
         /// </summary>
         bool TryGetNearInteractionPoint(XRNode hand, out HandJointPose jointPose);
 
         /// <summary>
-        /// The playspace-local pose of the grab/pinch location. This is typically
+        /// The play space local pose of the grab/pinch location. This is typically
         /// halfway between the thumb tip and the index tip.
         /// </summary>
         bool TryGetPinchingPoint(XRNode hand, out HandJointPose jointPose);
 
         /// <summary>
         /// How pinched the specific hand is.
         /// </summary>
-        /// <param name="isReadyToPinch"> returns whether the hand is in a pinch ready pose or not (within the camera's FOV and palm facing away from the user) </param>
-        /// <param name="isPinching"> If hand is not pinching at all, isPinching will be false. </param>
-        /// <param name="pinchAmount"> 0 for no pinch, 1 for fully pinched, or any floating point value in between. </param>
-        /// </returns>
+        /// <param name="isReadyToPinch">Represents whether the hand is in a pinch ready pose or not, within the camera's FOV and palm facing away from the user.</param>
+        /// <param name="isPinching">If hand is not pinching at all, this will be false.</param>
+        /// <param name="pinchAmount">This value will be <c>0</c> for no pinch, <c>1</c> for fully pinched, or any floating point value if in between.</param>
         bool TryGetPinchProgress(XRNode hand, out bool isReadyToPinch, out bool isPinching, out float pinchAmount);
 
         /// <summary>

com.microsoft.mrtk.core/Subsystems/MRTKSubsystemAttribute.cs

@@ -6,9 +6,9 @@
 namespace Microsoft.MixedReality.Toolkit.Subsystems
 {
     /// <summary>
-    /// Attribute marking a concrete, instantiatable MRTK subsystem.
+    /// Attribute marking a concrete and creatable MRTK subsystem.
     /// Subsystem classes marked with this attribute will be discoverable
-    /// to the <see cref="MRTKLifecycleManager"> and to the MRTK profile editor.
+    /// to the <see cref="MRTKLifecycleManager"/> and to the MRTK profile editor.
     /// </summary>
     [AttributeUsage(AttributeTargets.Class, Inherited = false)]
     public class MRTKSubsystemAttribute : Attribute, IMRTKSubsystemDescriptor

com.microsoft.mrtk.core/Subsystems/Speech/TextToSpeechSubsystemDescriptor.cs

@@ -34,7 +34,7 @@ public class TextToSpeechSubsystemDescriptor :
         /// <summary>
         /// Constructs a <c>TextToSpeechSubsystemDescriptor</c> based on the given parameters.
         /// </summary>
-        /// <param name=cinfo>The parameters required to initialize the descriptor.</param>
+        /// <param name="cinfo">The parameters required to initialize the descriptor.</param>
         TextToSpeechSubsystemDescriptor(TextToSpeechSubsystemCinfo cinfo) : base(cinfo)
         {
             // TODO: Initialize subsystem specific properties.
@@ -46,7 +46,7 @@ public class TextToSpeechSubsystemDescriptor :
         /// Creates a <c>TextToSpeechSubsystemDescriptor</c> based on the given parameters validating that the
         /// <c>id</c> and <c>implentationType</c> properties are specified.
         /// </summary>
-        /// <param name='cinfo'>The parameters required to initialize the descriptor.</param>
+        /// <param name="cinfo">The parameters required to initialize the descriptor.</param>
         /// <returns>
         /// The created <c>TextToSpeechSubsystemDescriptor</c>.
         /// </returns>

com.microsoft.mrtk.core/Utilities/Attributes/LabelWidthAttribute.cs

@@ -23,7 +23,7 @@ public class LabelWidthAttribute : PropertyAttribute
         /// <summary>
         /// Initializes a new instance of the <see cref="LabelWidthAttribute"/> class.
         /// </summary>
-        /// <param "name">The width to apply to the serializable property's label when the label is rendered in the Unity inspector window.</param>
+        /// <param name="width">The width to apply to the serializable property's label when the label is rendered in the Unity inspector window.</param>
         public LabelWidthAttribute(float width)
         {
             Width = width;

com.microsoft.mrtk.core/Utilities/ColorUtilities.cs

@@ -44,10 +44,10 @@ public static Gradient GradientLerpNoColor(Gradient a, Gradient b, float t)
         /// <summary>
         /// Compresses the gradient to the interval (p1, p2). The colors at the start and end of the result are the same as the gradient a.
         /// </summary>
-        /// <param name="a">The gradient we are trying to compress</param>
-        /// <param name="p1">The starting position of the compressed gradient. 0 <= p1 < p2 <= 1</param>
-        /// <param name="p2">The ending position of the compressed gradient. 0 <= p1 < p2 <= 1</param>
-        /// <returns>A new gradient with the gradient a compressed into the interval (p1, p2)</returns>
+        /// <param name="a">The gradient we are trying to compress.</param>
+        /// <param name="p1">The starting position of the compressed gradient, where 0 &lt;= p1 &lt; p2 &lt;= 1.</param>
+        /// <param name="p2">The ending position of the compressed gradient, where 0 &lt;= p1 &lt; p2 &lt;= 1.</param>
+        /// <returns>A new gradient with the gradient a compressed into the interval (p1, p2).</returns>
         public static Gradient GradientCompress(Gradient a, float p1, float p2)
         {
             if (p2 <= p1)

com.microsoft.mrtk.core/Utilities/ConfigureSpatializationSettings.cs

@@ -7,8 +7,7 @@ namespace Microsoft.MixedReality.Toolkit.Examples.Demos
 {
     /// <summary>
     /// Automatically configure an audio source to use a mixer-based
-    /// spatializer, such as the Microsoft Spatializer
-    /// <see cref="https://github.com/microsoft/spatialaudio-unity"/>.
+    /// spatializer, such as the <see href="https://github.com/microsoft/spatialaudio-unity">Microsoft Spatializer</see>.
     /// </summary>
     [RequireComponent(typeof(AudioSource))]
     public class ConfigureSpatializationSettings : MonoBehaviour

com.microsoft.mrtk.core/Utilities/PoseUtilities.cs

@@ -12,6 +12,7 @@ internal static class PoseUtilities
     {
         /// <summary>
         /// Returns an estimated distance from the provided pose to the user's body.
+        /// </summary>
         /// <remarks>
         /// The body is treated as a ray, parallel to the y-axis, where the start is head position.
         /// This means that moving your hand down such that is the same distance from the body will

com.microsoft.mrtk.core/Utilities/TimedFlag.cs

@@ -14,7 +14,7 @@ public class EditableTimedFlagAttribute : PropertyAttribute { }
     /// <summary>
     /// Represents a flag that can be activated or deactivated, and whose active duration is tracked and 
     /// obtained via the <see cref="GetTimeElapsedSinceSetActive"/> function. Instances of this object
-    /// will also raise <see cref="OnEntered"> and <see cref "OnExited"> events when their activate state is altered.
+    /// will also raise <see cref="OnEntered"/> and <see cref "OnExited"/> events when their activate state is altered.
     /// </summary>
     [System.Serializable]
     public class TimedFlag