Fix XML documentation warnings in MRTK3, round 2

UnityProjects/MRTKDevTemplate/Assets/BuildAssets/BuildApp.cs

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the Apache License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using System;
 using System.IO;
 using System.Linq;
@@ -10,6 +13,9 @@
 
 namespace Microsoft.MixedReality.Toolkit.Examples.Build
 {
+    /// <summary>
+    /// A static class that provides functions for compiling the example scenes via command line.
+    /// </summary>
     public static class BuildApp
     {
         private static string[] scenes = {
@@ -49,6 +55,9 @@ public static class BuildApp
 
         private static string buildPath = "build";
 
+        /// <summary>
+        /// Build the Unity project's example scenes.
+        /// </summary>
         public static void StartCommandLineBuild()
         {
             ParseBuildCommandLine();
@@ -82,6 +91,13 @@ public static void StartCommandLineBuild()
             EditorApplication.Exit(success ? 0 : 1);
         }
 
+        /// <summary>
+        /// Ensure that the Text Mesh Pro assets are included in the Unity project.
+        /// </summary>
+        /// <remarks>
+        /// This is currently not functioning correctly. When running via command line,
+        /// the assets are imported, but are not available in the built application.
+        /// </remarks>
         public static void EnsureTMPro()
         {
             string assetsFullPath = Path.GetFullPath("Assets/TextMesh Pro");
@@ -129,3 +145,4 @@ private static string[] SplitSceneList(string sceneList)
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,13 +1,16 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+// Licensed under the MIT License. 
+
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
 
 using System.Collections.Generic;
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
 {
     /// <summary>
-    /// Test DataController that logs a message event to the console
+    /// Test <see cref="IDataController"/> that logs a message event to the console.
     /// </summary>
     [AddComponentMenu("MRTK/Examples/Data Binding/Data Controller Test")]
     public class DataControllerTest : DataControllerGOBase
@@ -68,3 +71,4 @@ public override void ProcessCommand(string command, object data, Dictionary<stri
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
@@ -9,7 +12,7 @@ namespace Microsoft.MixedReality.Toolkit.Data
     /// Simple test data source that programmatically changes variables in a data source.
     /// </summary>
     /// <remarks>
-    /// Using a simple <key,value> store, it's possible to separate data from view
+    /// Using a simple key-value store, it's possible to separate data from view
     /// to simplify the integration of generic view prefabs that are populated from
     /// external information.
     /// </remarks>
@@ -22,3 +25,4 @@ public override IDataSource AllocateDataSource()
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,14 +1,19 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
 {
     /// <summary>
     /// Simple data source that generates a large list of randomly generated entries.
-    /// This can be used to test paging and virtualization.
     /// </summary>
+    /// <remarks>
+    /// This can be used to test paging and virtualization.
+    /// </remarks>
     [AddComponentMenu("MRTK/Examples/Data Binding/Data Source Dynamic List")]
     public class DataSourceDynamicList : DataSourceGOBase
     {
@@ -128,3 +133,4 @@ protected void InitializeDataSourceStatic()
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
@@ -10,7 +13,7 @@ namespace Microsoft.MixedReality.Toolkit.Data
     /// its reported content, in this case an image that populates a sprite.
     /// </summary>
     /// <remarks>
-    /// Using a simple <key,value> store, it's possible to separate data from view
+    /// Using a simple key-value store, it's possible to separate data from view
     /// to simplify the integration of generic view prefabs that are populated from
     /// external information.
     /// </remarks>
@@ -59,3 +62,4 @@ private void Update()
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,16 +1,20 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
 {
     /// <summary>
-    /// A simple data source that fetches JSON data from a specified URL every N seconds.
-    ///
+    /// A simple data source that fetches JSON data from a specified URL at a specified rate.
+    /// </summary>
+    /// <remarks>
     /// This will trigger notification changes by the base class once the data has been
     /// parsed.
-    /// </summary>
+    /// </remarks>
     [AddComponentMenu("MRTK/Examples/Data Binding/Data Source Json Test")]
     public class DataSourceJsonTest : DataSourceGOJson
     {
@@ -45,3 +49,4 @@ private void Update()
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,19 +1,26 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using System;
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
 {
     /// <summary>
-    /// A simple data source that fetches JSON data from a specified URL every N seconds.
-    ///
+    /// A simple data source that fetches JSON data from a specified URL at a specified rate.
+    /// </summary>
+    /// <remarks>
+    /// <para>
     /// This will trigger notification changes by the base class once the data has been
     /// parsed.
-    ///
-    /// Note: The theme can be changed by pressing theme buttons at http://TryMRTK.com
-    /// </summary>
+    /// </para>
+    /// <para>
+    /// Note: The theme can be changed by pressing theme buttons at http://TryMRTK.com.
+    /// </para>
+    /// </remarks>
     [AddComponentMenu("MRTK/Examples/Data Binding/Data Source Json Theme Test")]
     public class DataSourceJsonThemeTest : DataSourceGOJson
     {
@@ -63,3 +70,4 @@ private void Update()
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using System.Collections.ObjectModel;
 using UnityEngine;
 
@@ -10,7 +13,7 @@ namespace Microsoft.MixedReality.Toolkit.Data
     /// Simple test data source that programmatically changes variables in a data source.
     /// </summary>
     /// <remarks>
-    /// Using a simple <key,value> store, it's possible to separate data from view
+    /// Using a simple key-value store, it's possible to separate data from view
     /// to simplify the integration of generic view prefabs that are populated from
     /// external information.
     /// </remarks>
@@ -200,3 +203,4 @@ protected void Randomize(string[] items)
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
@@ -9,7 +12,7 @@ namespace Microsoft.MixedReality.Toolkit.Data
     /// Simple test data source that programmatically changes variables in a data source.
     /// </summary>
     /// <remarks>
-    /// Using a simple <key,value> store, it's possible to separate data from view
+    /// Using a simple key-value store, it's possible to separate data from view
     /// to simplify the integration of generic view prefabs that are populated from
     /// external information.
     /// </remarks>
@@ -49,3 +52,4 @@ public override IDataSource AllocateDataSource()
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
@@ -9,7 +12,7 @@ namespace Microsoft.MixedReality.Toolkit.Data
     /// Simple test data source that programmatically changes variables in a data source.
     /// </summary>
     /// <remarks>
-    /// Using a simple <key,value> store, it's possible to separate data from view
+    /// Using a simple key-value store, it's possible to separate data from view
     /// to simplify the integration of generic view prefabs that are populated from
     /// external information.
     /// </remarks>
@@ -117,3 +120,4 @@ private void InitializeData()
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using System;
 using UnityEngine;
 
@@ -49,7 +52,7 @@ public void NextTheme()
         }
 
         /// <summary>
-        /// A Unity Editor-only event function that is called when the script is loaded or a value changes in the Unity Inspector.
+        /// 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()
         {
@@ -86,3 +89,4 @@ public override IDataSource AllocateDataSource()
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using System;
 using UnityEngine;
 using UnityEngine.Serialization;
@@ -203,3 +206,4 @@ public SlateParameters SlateStyle
         }
     }
 }
+#pragma warning restore CS1591

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

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Data
@@ -57,3 +60,4 @@ public void UpdateThemeName()
         }
     }
 }
+#pragma warning restore CS1591

UnityProjects/MRTKDevTemplate/Assets/Scripts/AdjustLabelPosition.cs

@@ -1,14 +1,20 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Examples.Demos
 {
     /// <summary>
-    /// Script to adjust the position of this GameObject when another GameObject resizes.
-    /// Used to position see-it say-it labels when non-canvas button backplate resizes. 
+    /// Script to adjust the position of this <see cref="GameObject"/> when another
+    /// <see cref="GameObject"/> resizes.
     /// </summary>
+    /// <remarks>
+    /// Used to position see-it say-it labels when non-canvas button backplate resizes. 
+    /// </remarks>
     public class AdjustLabelPosition : MonoBehaviour
     {
         [SerializeField]
@@ -26,3 +32,4 @@ protected virtual void Awake()
         }
     }
 }
+#pragma warning restore CS1591

UnityProjects/MRTKDevTemplate/Assets/Scripts/BandPassFilterSelection.cs

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Disable "missing XML comment" warning for samples. While nice to have, this XML documentation is not required for samples.
+#pragma warning disable CS1591
+
 using System.Collections.Generic;
 using Microsoft.MixedReality.Toolkit.Audio;
 using TMPro;
@@ -37,3 +40,4 @@ public void SetFilter(int index)
         }
     }
 }
+#pragma warning restore CS1591