Merge pull request #2 from StansAssets/Fixes-for-roomful

chore: Updated project in order to use it in roomful project.

Author: stan-osipov

com.stansassets.xcode-project/Editor/Config/XCodeProjectSettings.cs

@@ -14,27 +14,60 @@
 
 namespace StansAssets.IOS.XCode
 {
-    class XCodeProjectSettings : PackageScriptableSettingsSingleton<XCodeProjectSettings>
+    /// <summary>
+    /// Xcode projects settings object.
+    /// Through it you can get access to all frameworks, libraries plist.list variables and others settings.
+    /// </summary>
+    public class XCodeProjectSettings : PackageScriptableSettingsSingleton<XCodeProjectSettings>
     {
+        /// <summary>
+        /// Name of the package.
+        /// </summary>
         public override string PackageName => XCodePackage.PackageName;
         protected override bool IsEditorOnly => true;
         public const string DefaultEntitlementsFileName = "default.entitlements";
         public const string CfLocalizationsPlistKey = "CFBundleLocalizations";
 
         //Post Process Libs
+        /// <summary>
+        /// Entry point for all frameworks in the xcode project.
+        /// </summary>
         public List<XCodeFramework> Frameworks = new List<XCodeFramework>();
+        /// <summary>
+        /// List of all embedded frameworks in the xcode project.
+        /// </summary>
         public List<XCodeEmbedFramework> EmbededFrameworks = new List<XCodeEmbedFramework>();
+        /// <summary>
+        /// List of all libraries in the xcode project.
+        /// </summary>
         public List<XCodeLibrary> Libraries = new List<XCodeLibrary>();
+        /// <summary>
+        /// List of all flags in the xcode project.
+        /// </summary>
         public List<XCodeProjectFlag> Flags = new List<XCodeProjectFlag>();
+        /// <summary>
+        /// List of info plist variables in the xcode project.
+        /// </summary>
         public List<InfoPlistKey> PlistVariables = new List<InfoPlistKey>();
+        /// <summary>
+        /// List of plist id's variables in the xcode project.
+        /// </summary>
         public List<PlistKeyId> VariableDictionary = new List<PlistKeyId>();
+        /// <summary>
+        /// List of all languages in the xcode project.
+        /// </summary>
         public List<SA_ISOLanguage> Languages = new List<SA_ISOLanguage>();
-
+        /// <summary>
+        /// Entry point for all shell scripts in the xcode project.
+        /// </summary>
         public List<XCodeShellScript> ShellScripts = new List<XCodeShellScript>();
 
         [SerializeField]
         List<XCodeProjectProperty> m_BuildProperties = new List<XCodeProjectProperty>();
 
+        /// <summary>
+        /// Is Post Process Enabled.
+        /// </summary>
         public static bool PostProcessEnabled
         {
             get
@@ -46,7 +79,13 @@ public static bool PostProcessEnabled
             }
         }
 
+        /// <summary>
+        /// Capability Settings.
+        /// </summary>
         public XCodeCapabilitySettings Capability = new XCodeCapabilitySettings();
+        /// <summary>
+        /// Xcode assets.
+        /// </summary>
         public List<XCodeAsset> Files = new List<XCodeAsset>();
         public EntitlementsGenerationMode EntitlementsMode = EntitlementsGenerationMode.Automatic;
         public Object EntitlementsFile = null;
@@ -55,6 +94,11 @@ public static bool PostProcessEnabled
         // Variables
         //--------------------------------------
 
+        /// <summary>
+        /// Method for adding new variable into <c>VariableDictionary</c> list.
+        /// </summary>
+        /// <param name="uniqueIdKey"> Unique id key</param>
+        /// <param name="var"> Info plist key value</param>
         public void AddVariableToDictionary(string uniqueIdKey, InfoPlistKey var)
         {
             var newVar = new PlistKeyId();
@@ -63,6 +107,11 @@ public void AddVariableToDictionary(string uniqueIdKey, InfoPlistKey var)
             VariableDictionary.Add(newVar);
         }
 
+        /// <summary>
+        /// Method that removes info plist key from <c>VariableDictionary</c> list.
+        /// </summary>
+        /// <param name="v"> Info plist key value.</param>
+        /// <param name="listWithThisVariable"> </param>
         public void RemoveVariable(InfoPlistKey v, IList listWithThisVariable)
         {
             if (Instance.PlistVariables.Contains(v))
@@ -91,6 +140,12 @@ public void RemoveVariable(InfoPlistKey v, IList listWithThisVariable)
             VariableDictionary = keysInUse;
         }
 
+        /// <summary>
+        /// Method that returns does <c>list</c> contains children with given <c>key</c>.
+        /// </summary>
+        /// <param name="id"> Id that we want to check for.</param>
+        /// <param name="list"> List of info plist in which we what to check.</param>
+        /// <returns></returns>
         bool IsInUse(string id, List<InfoPlistKey> list)
         {
             foreach (var key in list)
@@ -107,6 +162,11 @@ bool IsInUse(string id, List<InfoPlistKey> list)
             return false;
         }
 
+        /// <summary>
+        /// Method that returns info plist key by given key id.
+        /// </summary>
+        /// <param name="uniqueIdKey"> Uniques id</param>
+        /// <returns> <c>InfoPlistKey</c> or null if we couldn't find any.</returns>
         public InfoPlistKey GetVariableById(string uniqueIdKey)
         {
             foreach (var vid in VariableDictionary)
@@ -119,6 +179,9 @@ public InfoPlistKey GetVariableById(string uniqueIdKey)
         // Build Properties
         //--------------------------------------
 
+        /// <summary>
+        /// List of project build properties.
+        /// </summary>
         public List<XCodeProjectProperty> BuildProperties
         {
             get

com.stansassets.xcode-project/Editor/Core/XCodeProject.cs

@@ -12,6 +12,11 @@ public static class XCodeProject
         /// </summary>
         public static XCodeCapabilitySettings Capability => XCodeProjectSettings.Instance.Capability;
 
+        /// <summary>
+        /// Project Settings.
+        /// </summary>
+        public static XCodeProjectSettings Settings => XCodeProjectSettings.Instance;
+
         /// <summary>
         /// Sets a build property to the given value in all build configurations.
         /// </summary>

com.stansassets.xcode-project/Editor/Enum/EntitlementsGenerationMode.cs

@@ -1,6 +1,6 @@
 namespace StansAssets.IOS.XCode
 {
-    enum EntitlementsGenerationMode
+    public enum EntitlementsGenerationMode
     {
         Automatic,
         Manual,

com.stansassets.xcode-project/Editor/Models/PlistKeyId.cs

@@ -1,7 +1,7 @@
 namespace StansAssets.IOS.XCode
 {
     [System.Serializable]
-    class PlistKeyId
+    public class PlistKeyId
     {
         public InfoPlistKey VariableValue;
         public string uniqueIdKey;

com.stansassets.xcode-project/Editor/Models/XCodeEmbedFramework.cs

@@ -1,5 +1,5 @@
 namespace StansAssets.IOS.XCode
 {
     [System.Serializable]
-    class XCodeEmbedFramework : XCodeAsset { }
+    public class XCodeEmbedFramework : XCodeAsset { }
 }

com.stansassets.xcode-project/Editor/Models/XCodeShellScript.cs

@@ -1,7 +1,7 @@
 namespace StansAssets.IOS.XCode
 {
     [System.Serializable]
-    class XCodeShellScript
+    public class XCodeShellScript
     {
         public string Name = "New Run Script";
         public string Shell = string.Empty;

com.stansassets.xcode-project/Editor/StansAssets.IOS.XCode.asmdef

@@ -1,10 +1,10 @@
 {
     "name": "StansAssets.IOS.XCode",
     "references": [
-        "GUID:9c2d25c8e11a94c0db463f6b069b38f4",
-        "GUID:618d739a61acd4b7d86dceb8592359b2",
-        "GUID:db0eb1f6c1244402aa4d287a997cdb47",
-        "GUID:e322f1a843d5b4f8095d71c70e5fbccc"
+        "StansAssets.Foundation.Editor",
+        "StansAssets.Foundation",
+        "StansAssets.Plugins",
+        "StansAssets.Plugins.Editor"
     ],
     "includePlatforms": [
         "Editor"