Property to method and docs

Author: keveleigh

org.mixedrealitytoolkit.core/Editor/MRTKBuildPreferences.cs

@@ -51,7 +51,7 @@ private static SettingsProvider BuildPreferences()
 
             static void GUIHandler(string searchContext)
             {
-                EditorGUILayout.HelpBox($"These settings are serialized into MRTKSettings.asset in {MRTKFiles.GeneratedFolderPath}.\nThis file can be checked into source control to maintain consistent settings across collaborators.", MessageType.Info);
+                EditorGUILayout.HelpBox($"These settings are serialized into MRTKSettings.asset in {MRTKFiles.GetOrCreateGeneratedFolderPath()}.\nThis file can be checked into source control to maintain consistent settings across collaborators.", MessageType.Info);
                 DrawAppLauncherModelField();
             }
 

org.mixedrealitytoolkit.core/Editor/MRTKFiles.cs

@@ -8,6 +8,9 @@
 
 namespace MixedReality.Toolkit.Editor
 {
+    /// <summary>
+    /// Provides helper methods for accessing MRTK-defined files and folders.
+    /// </summary>
     public class MRTKFiles
     {
         private const string GeneratedName = "MRTK.Generated";
@@ -17,38 +20,43 @@ public class MRTKFiles
         private static readonly string DefaultSentinelFilePath = Path.Combine(DefaultGeneratedFolderPath, GeneratedSentinelFileName);
         private static string generatedFolderPath = string.Empty;
 
-        public static string GeneratedFolderPath
+        /// <summary>
+        /// Finds the current MRTK.Generated folder based on the sentinel file. If a sentinel file is not found,
+        /// a new MRTK.Generated folder and sentinel are created and this new path is returned.
+        /// </summary>
+        /// <returns>The AssetDatabase-compatible path to the MRTK.Generated folder.</returns>
+        public static string GetOrCreateGeneratedFolderPath()
         {
-            get
+            if (string.IsNullOrWhiteSpace(generatedFolderPath))
             {
-                if (string.IsNullOrWhiteSpace(generatedFolderPath))
+                foreach (string guid in AssetDatabase.FindAssets(GeneratedName))
                 {
-                    foreach (string guid in AssetDatabase.FindAssets(GeneratedName))
+                    string path = AssetDatabase.GUIDToAssetPath(guid);
+                    if (path.Contains(GeneratedSentinelFileName))
                     {
-                        string path = AssetDatabase.GUIDToAssetPath(guid);
-                        if (path.Contains(GeneratedSentinelFileName))
-                        {
-                            generatedFolderPath = Path.GetDirectoryName(path);
-                            return generatedFolderPath;
-                        }
+                        generatedFolderPath = Path.GetDirectoryName(path);
+                        return generatedFolderPath;
                     }
+                }
 
-                    if (!Directory.Exists(DefaultGeneratedFolderPath))
-                    {
-                        Directory.CreateDirectory(DefaultGeneratedFolderPath);
-                    }
+                if (!Directory.Exists(DefaultGeneratedFolderPath))
+                {
+                    Directory.CreateDirectory(DefaultGeneratedFolderPath);
+                }
 
-                    if (!File.Exists(DefaultSentinelFilePath))
-                    {
-                        // Make sure we create and dispose/close the filestream just created
-                        using FileStream f = File.Create(DefaultSentinelFilePath);
-                    }
-                    generatedFolderPath = DefaultGeneratedFolderPath;
+                if (!File.Exists(DefaultSentinelFilePath))
+                {
+                    // Make sure we create and dispose/close the filestream just created
+                    using FileStream f = File.Create(DefaultSentinelFilePath);
                 }
-                return generatedFolderPath;
+                generatedFolderPath = DefaultGeneratedFolderPath;
             }
+            return generatedFolderPath;
         }
 
+        /// <summary>
+        /// Checks for an existing MRTK.Generated sentinel file on asset import. Allows the path to be pre-cached before use.
+        /// </summary>
         private class AssetPostprocessor : UnityEditor.AssetPostprocessor
         {
             public static void OnPostprocessAllAssets(string[] importedAssets, string[] deletedAssets, string[] movedAssets, string[] movedFromAssetPaths)

org.mixedrealitytoolkit.core/Editor/MRTKSettings.cs

@@ -14,7 +14,7 @@ namespace MixedReality.Toolkit.Editor
     [System.Serializable]
     public class MRTKSettings : ScriptableObject
     {
-        internal static string MRTKSettingsPath => Path.Combine(MRTKFiles.GeneratedFolderPath, "MRTKSettings.asset");
+        internal static string MRTKSettingsPath => Path.Combine(MRTKFiles.GetOrCreateGeneratedFolderPath(), "MRTKSettings.asset");
 
         [SerializeField]
         private SerializableDictionary<BuildTargetGroup, MRTKProfile> settings = new SerializableDictionary<BuildTargetGroup, MRTKProfile>();

org.mixedrealitytoolkit.tools/SubsystemWizard/SubsystemGenerator.cs

@@ -159,7 +159,7 @@ public void Generate(
         {
             // Make sure there is a folder in which to create the new files.
             DirectoryInfo outputFolder = new DirectoryInfo(
-                Path.Combine(MRTKFiles.GeneratedFolderPath, SubsystemName));
+                Path.Combine(MRTKFiles.GetOrCreateGeneratedFolderPath(), SubsystemName));
             if (!outputFolder.Exists)
             {
                 outputFolder.Create();

org.mixedrealitytoolkit.tools/SubsystemWizard/SubsystemWizardWindow.cs

@@ -247,7 +247,7 @@ private void RenderWizardPreGeneratePage()
                 }
 
                 EditorGUILayout.LabelField(
-                    $"The new subsystem will be created in your project's {Path.Combine(MRTKFiles.GeneratedFolderPath, subsystemGenerator.SubsystemName)} folder.",
+                    $"The new subsystem will be created in your project's {Path.Combine(MRTKFiles.GetOrCreateGeneratedFolderPath(), subsystemGenerator.SubsystemName)} folder.",
                     EditorStyles.boldLabel);
 
                 EditorGUILayout.Space(6);
@@ -345,7 +345,7 @@ private void RenderWizardCompletePage()
         {
             StringBuilder sb = new StringBuilder();
             int step = 1;
-            sb.AppendLine($" {step}. In the Project view, navigate to {Path.Combine(MRTKFiles.GeneratedFolderPath, subsystemGenerator.SubsystemName)}");
+            sb.AppendLine($" {step}. In the Project view, navigate to {Path.Combine(MRTKFiles.GetOrCreateGeneratedFolderPath(), subsystemGenerator.SubsystemName)}");
             step++;
             sb.AppendLine($" {step}. Open {subsystemGenerator.DescriptorName}.cs");
             step++;