Fixing XML documentation warnings in MRTK3 and some variable name spelling fixes, first pass

UnityProjects/MRTKDevTemplate/Assets/Data Binding Example/Scripts/DataControllerTest.cs

@@ -23,6 +23,9 @@ public class DataControllerTest : DataControllerGOBase
 
         private IDataSource _dataSource;
 
+        /// <summary>
+        /// A Unity event function that is called when the script component has been enabled.
+        /// </summary>
         private void OnEnable()
         {
             GetNearestDataSource("data");

UnityProjects/MRTKDevTemplate/Assets/Data Binding Example/Scripts/DataSourceDynamicList.cs

@@ -28,6 +28,9 @@ public override IDataSource AllocateDataSource()
             return new DataSourceObjects();
         }
 
+        /// <summary>
+        /// A Unity event function that is called every frame, if this object is enabled.
+        /// </summary>
         private void Update()
         {
             _counter++;

UnityProjects/MRTKDevTemplate/Assets/Data Binding Example/Scripts/DataSourceImageUrlTest.cs

@@ -42,6 +42,9 @@ protected override void InitializeDataSource()
             _time = secondsBetweenFetches;
         }
 
+        /// <summary>
+        /// A Unity event function that is called every frame, if this object is enabled.
+        /// </summary>
         private void Update()
         {
             _time += Time.deltaTime;

UnityProjects/MRTKDevTemplate/Assets/Data Binding Example/Scripts/DataSourceJsonTest.cs

@@ -29,6 +29,9 @@ protected override void InitializeDataSource()
             _time = secondsBetweenFetches;
         }
 
+        /// <summary>
+        /// A Unity event function that is called every frame, if this object is enabled.
+        /// </summary>
         private void Update()
         {
             _time += Time.deltaTime;

UnityProjects/MRTKDevTemplate/Assets/Data Binding Example/Scripts/DataSourceJsonThemeTest.cs

@@ -47,6 +47,9 @@ protected void JsonFetchSuccess(string jsonText, object requestRef)
             }
         }
 
+        /// <summary>
+        /// A Unity event function that is called every frame, if this object is enabled.
+        /// </summary>
         private void Update()
         {
             _time += Time.deltaTime;

UnityProjects/MRTKDevTemplate/Assets/Data Binding Example/Scripts/DataSourceReflectionListTest.cs

@@ -90,12 +90,18 @@ public string[] GetDataSourceTypes()
             return new string[] { dataSourceType };
         }
 
+        /// <summary>
+        /// A Unity event function that is called when the script component has been enabled.
+        /// </summary>
         private void OnEnable()
         {
             GetDataSource(dataSourceType);
             InitializeData();
         }
 
+        /// <summary>
+        /// A Unity event function that is called every frame, if this object is enabled.
+        /// </summary>
         private void Update()
         {
             if (_fluxCollectionSize > 0)

UnityProjects/MRTKDevTemplate/Assets/Data Binding Example/Scripts/DataSourceTest.cs

@@ -58,6 +58,9 @@ protected override void InitializeDataSource()
             _nextOneSecondTarget = 0;
         }
 
+        /// <summary>
+        /// A Unity event function that is called every frame, if this object is enabled.
+        /// </summary>
         private void Update()
         {
             Sprite[] statusSprites = { statusSpriteOpen, statusSpritePending, statusSpriteCancelled, statusSpriteInProgress, statusSpriteCompleted };

UnityProjects/MRTKDevTemplate/Assets/Data Binding Example/Scripts/DataSourceThemeTest.cs

@@ -48,11 +48,17 @@ public void NextTheme()
             ChangeTheme((currentTheme + 1) % availableThemes.Length);
         }
 
+        /// <summary>
+        /// A Unity Editor-only event function that is called when the script is loaded or a value changes in the Unity Inspector.
+        /// </summary>
         private void OnValidate()
         {
             ChangeTheme(currentTheme);
         }
 
+        /// <summary>
+        /// A Unity event function that is called every frame, if this object is enabled.
+        /// </summary>
         private void Update()
         {
             if (_lastTheme != currentTheme)

UnityProjects/MRTKDevTemplate/Assets/Prefabs/CanvasExample/HeroButton.prefab

@@ -1428,15 +1428,15 @@ MonoBehaviour:
   <OnDisabled>k__BackingField:
     m_PersistentCalls:
       m_Calls: []
-  smoothSelectedness: 1
+  smoothSelectionProgress: 1
   distanceSpaceMode: 1
   startPushPlane: -8.392723
   endPushPlane: -0.67
   returnSpeed: 0.25
   enforceFrontPush: 1
-  rejectXYRolloff: 1
-  rolloffXYDepth: 3
-  rejectZRolloff: 0
+  rejectXYRollOff: 1
+  rollOffXYDepth: 3
+  rejectZRollOff: 0
   extendSpeed: 0.5
 --- !u!114 &9062819528647497188
 MonoBehaviour:

UnityProjects/MRTKDevTemplate/Assets/Prefabs/SampleSceneHelper/DescriptionPanel.prefab

@@ -547,8 +547,8 @@ MonoBehaviour:
     m_PersistentCalls:
       m_Calls: []
   m_text: StatefulPressableButton defines the pressability of an object, by overriding
-    the virtual Selectedness() function. The PressableButtonVisuals interprets this
-    Selectedness, along with the other conditions + flags exposed by MRTKBaseInteractable
+    the virtual GetSelectionProgress() function. The PressableButtonVisuals interprets this
+    GetSelectionProgress(), along with the other conditions + flags exposed by MRTKBaseInteractable
     and StatefulInteractable, to drive the complex visual feedback you see here.
   m_isRightToLeft: 0
   m_fontAsset: {fileID: 11400000, guid: fea6b26abeefbc547b6aca1dbda0a34d, type: 2}

UnityProjects/MRTKDevTemplate/Assets/Scenes/HandInteractionExamples.unity

@@ -2802,8 +2802,8 @@ MonoBehaviour:
 
 
     PressableButtons
-    use StatefulInteractable''s Selectedness to model the compressability of a 3D
-    pressable surface. These interactables drive Selectedness through a combination
+    use StatefulInteractable''s selection progress to model the compressability of a 3D
+    pressable surface. These interactables drive selection progress through a combination
     of any number of interactors.'
   m_isRightToLeft: 0
   m_fontAsset: {fileID: 11400000, guid: 533bdd8d5c92b52448ee2ecf7bd828a4, type: 2}
@@ -6496,7 +6496,7 @@ MonoBehaviour:
 
 
     <size=8>Dynamic
-    visual feedback based on the amount of pinch gesture (Selectedness) using StateVisualizer''s
+    visual feedback based on the amount of pinch gesture (selection progress) using StateVisualizer''s
     ''Playback Time Matches Value''. Hover highlight is activated by MeshOutline
     script.
 
@@ -11973,55 +11973,55 @@ PrefabInstance:
       value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.size
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.size
       value: 1
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_Mode
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_Mode
       value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_Mode
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_Mode
       value: 1
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_Target
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_Target
       value: 
       objectReference: {fileID: 2123527399}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_Target
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_Target
       value: 
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_CallState
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_CallState
       value: 2
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_CallState
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_CallState
       value: 2
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_MethodName
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_MethodName
       value: SpinObjectWithSlider
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_MethodName
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_MethodName
       value: 
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_TargetAssemblyTypeName
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_TargetAssemblyTypeName
       value: Microsoft.MixedReality.Toolkit.Examples.Demos.ObjectSpinner, Assembly-CSharp
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_TargetAssemblyTypeName
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_TargetAssemblyTypeName
       value: Microsoft.MixedReality.Toolkit.Examples.Demos.SliderGemSpinner, Assembly-CSharp
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_Arguments.m_ObjectArgumentAssemblyTypeName
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[0].m_Arguments.m_ObjectArgumentAssemblyTypeName
       value: UnityEngine.Object, UnityEngine
       objectReference: {fileID: 0}
     - target: {fileID: 9075688916865880869, guid: 7148f9ce86f62ab4b8d89dc6cfa369a0, type: 3}
-      propertyPath: OnValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_Arguments.m_ObjectArgumentAssemblyTypeName
+      propertyPath: onValueUpdated.m_PersistentCalls.m_Calls.Array.data[1].m_Arguments.m_ObjectArgumentAssemblyTypeName
       value: 
       objectReference: {fileID: 0}
     m_RemovedComponents: []

UnityProjects/MRTKDevTemplate/Assets/Scenes/InteractableButtonExamples.unity

@@ -5650,7 +5650,7 @@ PrefabInstance:
         selection.
 
 
-        The virtual Selectedness method can be overridden to
+        The virtual GetSelectionProgress() method can be overridden to
         support more kinds of variable selection, like volumetric press. By default,
         StatefulInteractables will receive the variable selection amount from all
         participating IVariableSelectInteractors.'
@@ -20980,7 +20980,7 @@ PrefabInstance:
     - target: {fileID: 2446705927233332293, guid: e8c3ea3c1046f8b4bbd682c2b7a0e4fe, type: 3}
       propertyPath: m_text
       value: 'PressableButton defines the pressability of an object by overriding
-        the virtual Selectedness() function.
+        the virtual GetSelectionProgress() function.
 
 
         Notably, PressableButton,

UnityProjects/MRTKDevTemplate/Assets/Scenes/SolverExamples.unity

@@ -5425,7 +5425,7 @@ MonoBehaviour:
   maxViewHorizontalDegrees: 30
   maxViewVerticalDegrees: 20
   reorientWhenOutsideParameters: 1
-  orientToControllerDeadzoneDegrees: 60
+  orientToControllerDeadZoneDegrees: 60
   ignoreAngleClamp: 0
   ignoreDistanceClamp: 0
   ignoreReferencePitchAndRoll: 0

UnityProjects/MRTKDevTemplate/Assets/Scripts/AdjustLabelPosition.cs

@@ -15,7 +15,10 @@ public class AdjustLabelPosition : MonoBehaviour
         [Tooltip("The object whose dimensions controls the placement of this object.")]
         private Transform control;
 
-        private void Awake()
+        /// <summary>
+        /// A Unity event function that is called when an enabled script instance is being loaded.
+        /// </summary>
+        protected virtual void Awake()
         {
             // Calculate the new position of the label based on the current size of the backplate
             float childOffset = ((control.lossyScale.y) / 2f * -1);

UnityProjects/MRTKDevTemplate/Assets/Scripts/BandPassFilterSelection.cs

@@ -23,6 +23,9 @@ public class BandPassFilterSelection : MonoBehaviour
 
         private AudioBandPassEffect effect = null;
 
+        /// <summary>
+        /// A Unity event function that is called on the frame when a script is enabled just before any of the update methods are called the first time.
+        /// </summary> 
         private void Start()
         {
             effect = audioEmitter.EnsureComponent<AudioBandPassEffect>();

UnityProjects/MRTKDevTemplate/Assets/Scripts/ColorChanger.cs

@@ -19,6 +19,9 @@ public class ColorChanger : MonoBehaviour
 
         private int currentMaterialSelection;
 
+        /// <summary>
+        /// A Unity event function that is called on the frame when a script is enabled just before any of the update methods are called the first time.
+        /// </summary> 
         private void Start()
         {
             if (meshRenderer == null)

UnityProjects/MRTKDevTemplate/Assets/Scripts/DialogExample.cs

@@ -10,7 +10,10 @@ public class DialogExample : MonoBehaviour
     {
         public DialogPool DialogPool;
 
-        public void Awake()
+        /// <summary>
+        /// A Unity event function that is called when an enabled script instance is being loaded.
+        /// </summary>
+        protected virtual void Awake()
         {
             if (DialogPool == null)
             {

UnityProjects/MRTKDevTemplate/Assets/Scripts/EyeCalibrationWarning.cs

@@ -40,6 +40,9 @@ public TMP_Text Text
             set => text = value;
         }
 
+        /// <summary>
+        /// A Unity event function that is called when the script component has been enabled.
+        /// </summary>
         private void OnEnable()
         {
             if (checker == null)

UnityProjects/MRTKDevTemplate/Assets/Scripts/GridSqueezer.cs

@@ -50,11 +50,11 @@ public GridLayoutGroup GridLayoutGroup
         }
 
         [SerializeField]
-        [Tooltip("The RectTransform to fit the collider onto.")]
+        [Tooltip("The AttachedRectTransform to fit the collider onto.")]
         private RectTransform rectTransform;
 
         /// <summary>
-        /// The RectTransform to fit the collider onto.
+        /// The AttachedRectTransform to fit the collider onto.
         /// </summary>
         public RectTransform RectTransform
         {
@@ -68,7 +68,11 @@ public RectTransform RectTransform
             }
             set => rectTransform = value;
         }
-        void Update()
+
+        /// <summary>
+        /// A Unity event function that is called every frame, if this object is enabled.
+        /// </summary>
+        private void Update()
         {
             if (!(Application.isPlaying && !DynamicFitting) && GridLayoutGroup != null && RectTransform != null && RectTransform.hasChanged)
             {

UnityProjects/MRTKDevTemplate/Assets/Scripts/InspectorDrivenDialog.cs

@@ -10,6 +10,9 @@
 
 namespace Microsoft.MixedReality.Toolkit.Examples.Demos
 {
+    /// <summary>
+    /// A helper component for creating a <see cref="DialogPool"/> and showing <see cref="IDialog"/> objects.
+    /// </summary>
     public class InspectorDrivenDialog : MonoBehaviour
     {
         // A handy struct for keeping button actions and their labels together.
@@ -39,6 +42,9 @@ internal struct Option
         [SerializeField]
         private Option neutral;
 
+        /// <summary>
+        /// A Unity event function that is called when the script component has been enabled.
+        /// </summary>
         protected virtual void OnEnable()
         {
             if (DialogPool == null)
@@ -47,6 +53,9 @@ protected virtual void OnEnable()
             }
         }
 
+        /// <summary>
+        /// Show a <see cref="IDialog"/> object using the currently set text and button options.
+        /// </summary>
         public void Show()
         {
             // Any fields left blank in the inspector are considered

UnityProjects/MRTKDevTemplate/Assets/Scripts/PenInteractor.cs

@@ -87,7 +87,10 @@ void OnTriggerStay(Collider c)
             }
         }
 
-        void FixedUpdate()
+        /// <summary>
+        /// A Unity event function that is called at an framerate independent frequency, and is only called if this object is enabled.
+        /// </summary>
+        private void FixedUpdate()
         {
             hoveredTargets.Clear();
         }