Merge pull request googlesamples#179 from Si1ver/master

Fixed typos in documentation and comments.

Author: Stewart Miles

CHANGELOG.md

@@ -238,7 +238,7 @@
 
 # Version 1.2.66 - April 27, 2018
 ## Bug Fixes
-* Fixed Version Handler renaming of Linux libraries with hypens in filenames.
+* Fixed Version Handler renaming of Linux libraries with hyphens in filenames.
   Previously, libraries named Foo-1.2.3.so were not being renamed to
   libFoo-1.2.3.so on Linux which could break native library loading on some
   versions of Unity.
@@ -298,7 +298,7 @@
 # Version 1.2.57 - Oct 18, 2017
 ## Bug Fixes
 * Updated Gradle wrapper to 4.2.1 to fix issues using Gradle with the
-  latest openjdk.
+  latest Openjdk.
 * Android Gradle resolution now also uses gradle.properties to pass
   parameters to Gradle in an attempt to workaround problems with
   command line argument parsing on Windows 10.
@@ -329,7 +329,7 @@
 ## Bug Fixes
 * Improved Android Resolver auto-resolution speed.
 * Fixed bug in the Gradle Android Resolver which would result in resolution
-  succeding when some dependencies are not found.
+  succeeding when some dependencies are not found.
 
 # Version 1.2.52 - Sep 25, 2017
 ## New Features
@@ -363,7 +363,7 @@
 ## Bug Fixes
 * Removed modulemap parsing in iOS Resolver.
   The framework *.modulemap did not need to be parsed by the iOS Resolver
-  when injecting Cocaopods into a Xcode project.  Simply adding a modular
+  when injecting Cocoapods into a Xcode project.  Simply adding a modular
   framework to a Xcode project results in Xcode's Clang parsing the associated
   modulemap and injecting any compile and link flags into the build process.
 
@@ -493,7 +493,7 @@
 ## New Features
 * Added support for build target selection based upon .NET framework
   version in the VersionHandler.
-  When appling either gvh\_dotnet-3.5 or gvh\_dotnet-4.5 labels to
+  When applying either gvh\_dotnet-3.5 or gvh\_dotnet-4.5 labels to
   assets, the VersionHandler will only enable the asset for the
   specified set of build targets when the matching .NET framework version
   is selected in Unity 2017's project settings.  This allows assets
@@ -680,7 +680,7 @@
 
 # Version 1.2.3 - Oct 25, 2016
 ## Bug Fixes
-* Fixed exception when reporting conflicting depedencies.
+* Fixed exception when reporting conflicting dependencies.
 
 # Version 1.2.2 - Oct 17, 2016
 ## Bug Fixes

README.md

@@ -246,7 +246,7 @@ Manual resolution can be performed using the following menu options:
 Some AAR files (for example play-services-measurement) contain variables that
 are processed by the Android Gradle plugin.  Unfortunately, Unity does not
 perform the same processing when using Unity's Internal Build System, so the
-Android Resolver plugin handles known cases of this variable substition
+Android Resolver plugin handles known cases of this variable substitution
 by exploding the AAR into a folder and replacing `${applicationId}` with the
 `bundleID`.
 

sample/Assets/PlayServicesResolver/Editor/Resolver.cs

@@ -65,7 +65,7 @@ public ResolverImpl(object svcSupport)
 			/// LATEST means the only the latest version.
 			/// </para>
 			/// </remarks>
-			/// <param name="group">Group - the Group Id of the artiface</param>
+			/// <param name="group">Group - the Group Id of the artifact</param>
 			/// <param name="artifact">Artifact - Artifact Id</param>
 			/// <param name="version">Version - the version constraint</param>
 			/// <param name="packageIds">Optional list of Android SDK package identifiers.</param>
@@ -101,11 +101,11 @@ public ResolverImpl DependOn(string group, string artifact, string version, stri
 		/// class should be loaded from.</param>
 		public static ResolverImpl CreateSupportInstance(string clientName, string assemblyName = "Google.JarResolver")
 		{
-			// if we arent on Android default to an empty shim
+			// if we aren't on Android default to an empty shim
 			if (EditorUserBuildSettings.activeBuildTarget != BuildTarget.Android)
 				return new ResolverImpl(null);
 
-			// bail out with an empty instance if the PlayServicesSupport class isnt available
+			// bail out with an empty instance if the PlayServicesSupport class isn't available
 			var playServicesSupport = Google.VersionHandler.FindClass(assemblyName, "Google.JarResolver.PlayServicesSupport");
 			if (playServicesSupport == null)
 				return new ResolverImpl(null);

source/IOSResolver/src/IOSResolver.cs

@@ -648,7 +648,7 @@ static IOSResolver() {
         RemapXcodeExtension();
         // NOTE: It's not possible to catch exceptions a missing reference
         // to the UnityEditor.iOS.Xcode assembly in this method as the runtime
-        // will attempt to load the assemebly before the method is executed so
+        // will attempt to load the assembly before the method is executed so
         // we handle exceptions here.
         try {
             InitializeTargetName();
@@ -1068,7 +1068,7 @@ private static void AddPodInternal(string podName,
             if (!pod.Equals(existingPod)) {
                 Log(String.Format("Pod {0} already present, ignoring.\n" +
                                   "Original declaration {1}\n" +
-                                  "Ignored declarion {2}\n", podName,
+                                  "Ignored declaration {2}\n", podName,
                                   pods[podName].createdBy, createdBy ?? "(unknown)"),
                     level: LogLevel.Warning);
             }
@@ -1146,7 +1146,7 @@ public static bool UpdateTargetSdk() {
     /// </summary>
     /// <returns>Key value pair of minimum SDK version (key) and
     /// a list of pod names that require it (value) if the currently
-    /// selected target SDK version does not satify pod requirements, the list
+    /// selected target SDK version does not satisfy pod requirements, the list
     /// (value) is null otherwise.</returns>
     private static KeyValuePair<int, List<string>> TargetSdkNeedsUpdate() {
         var kvpair = new KeyValuePair<int, List<string>>(0, null);
@@ -1839,7 +1839,7 @@ private static string FindPodTool() {
     /// </summary>
     private class CommandItem {
         /// <summary>
-        /// Command to excecute.
+        /// Command to execute.
         /// </summary>
         public string Command { get; set; }
         /// <summary>

source/JarResolverLib/src/Google.JarResolver/Dependency.cs

@@ -23,7 +23,7 @@ namespace Google.JarResolver {
     /// Represents a dependency.  A dependency is defined by a groupId,
     /// artifactId and version constraint.  This information is used to search
     /// the repositories of artifacts to find a version that meets the version
-    /// contraints (as well as be compatible with other dependencies' constraints).
+    /// constraints (as well as be compatible with other dependencies' constraints).
     /// </summary>
     public class Dependency {
         // Extensions of files managed by the resolver.

source/JarResolverLib/src/Google.JarResolver/PlayServicesSupport.cs

@@ -253,7 +253,7 @@ private static Dependency AddCommonPackageIds(Dependency dep) {
         /// LATEST means the only the latest version.
         /// </para>
         /// </remarks>
-        /// <param name="group">Group - the Group Id of the artiface</param>
+        /// <param name="group">Group - the Group Id of the artifact</param>
         /// <param name="artifact">Artifact - Artifact Id</param>
         /// <param name="version">Version - the version constraint</param>
         /// <param name="packageIds">Optional list of Android SDK package identifiers.</param>

source/PackageManager/src/Constants.cs

@@ -73,7 +73,7 @@ public class Constants {
         /// </summary>
         public const double FETCH_TIMOUT_THRESHOLD = 10.0d;
         /// <summary>
-        /// The gpm deps xml postfix used to check for pacakge deps.
+        /// The gpm deps xml postfix used to check for package deps.
         /// </summary>
         public const string GPM_DEPS_XML_POSTFIX = "gpm.dep.xml";
         /// <summary>

source/PackageManager/src/Controllers.cs

@@ -205,7 +205,7 @@ public static string DownloadCachePath {
             }
         }
         /// <summary>
-        /// Verbose logging propery flag.
+        /// Verbose logging property flag.
         /// </summary>
         public static bool VerboseLogging {
             get {
@@ -276,7 +276,7 @@ public enum ResponseCode {
         /// </summary>
         PLUGIN_INSTALLED,
         /// <summary>
-        /// Plugin resolution (getting its data from source) succeded
+        /// Plugin resolution (getting its data from source) succeeded
         /// </summary>
         PLUGIN_RESOLVED,
         /// <summary>
@@ -333,7 +333,7 @@ public interface IUriDataFetcher {
         /// <param name="result">Result string.</param>
         ResponseCode BlockingFetchAsString(Uri uri, out string result);
         /// <summary>
-        /// Thead blocking fetch for a byte[] result.
+        /// Thread blocking fetch for a byte[] result.
         /// </summary>
         /// <returns>The fetch as bytes.</returns>
         /// <param name="uri">URI.</param>
@@ -417,7 +417,7 @@ public static void SwapUriDataFetcher(IUriDataFetcher newFetcher) {
     }
 
     /// <summary>
-    /// Some constants are inconvenent for testing purposes. This class wraps the constants that
+    /// Some constants are inconvenient for testing purposes. This class wraps the constants that
     /// may be changed during test execution.
     /// </summary>
     public static class TestableConstants {
@@ -554,7 +554,7 @@ static void CreateRegistryDatabase() {
         }
 
         /// <summary>
-        /// Refreshs the registry cache for the provided RegistryWrapper.
+        /// Refreshes the registry cache for the provided RegistryWrapper.
         /// </summary>
         /// <param name="wrapper">Wrapper.</param>
         public static void RefreshRegistryCache(RegistryWrapper wrapper = null) {
@@ -721,7 +721,7 @@ public class PackagedPlugin {
     /// </summary>
     public static class PluginManagerController {
         /// <summary>
-        /// The plugin cache assiciates RegistryWrapper keys to lists of PackagedPlugins that are
+        /// The plugin cache associates RegistryWrapper keys to lists of PackagedPlugins that are
         /// part of the set of plugins defined by the Registry.
         /// </summary>
         static Dictionary<RegistryWrapper, List<PackagedPlugin>> pluginCache =
@@ -775,7 +775,7 @@ public static PackagedPlugin GetPluginForVersionlessKey(string versionlessKey) {
 
         /// <summary>
         /// Gets the list of all plugins across all registered registries. If
-        /// refresh is true then the plugin data returned is gaurenteed to be
+        /// refresh is true then the plugin data returned is guaranteed to be
         /// up to date since each plugin source data is fetched prior to this
         /// method returning.
         /// </summary>
@@ -1138,7 +1138,7 @@ static void Update() {
             }
 
             if (projectDirty) {
-                // check project for re-resolve on target if ditry
+                // check project for re-resolve on target if dirty
                 RefreshProject();
             }
         }
@@ -1190,7 +1190,7 @@ static void RemoveClient(string clientName) {
         }
 
         /// <summary>
-        /// Refreshs the client, resolves it's dependencies if needed.
+        /// Refreshes the client, resolves it's dependencies if needed.
         /// </summary>
         /// <param name="client">Client.</param>
         static void RefreshClient(ProjectClient client) {
@@ -1485,7 +1485,7 @@ static string GetProjectRecordPath() {
         }
 
         /// <summary>
-        /// Refreshs the list of asset labels that are present in the current project.
+        /// Refreshes the list of asset labels that are present in the current project.
         /// This method does NOT modify the asset labels on assets, it just reads them all.
         /// </summary>
         public static void RefreshListOfAssetLabels() {

source/PackageManager/src/Models.cs

@@ -124,15 +124,15 @@ public string GenerateAssetLabel() {
         }
 
         /// <summary>
-        /// Generates the unique key basd on the current groupId, artifactId and version.
+        /// Generates the unique key based on the current groupId, artifactId and version.
         /// </summary>
         /// <returns>The unique key.</returns>
         public string GenerateUniqueKey() {
             if (groupId == null || artifactId == null || version == null) {
                 throw new Exception(string.Format("Attempted to generate unique " +
                                                   "key on object {0} without setting " +
                                                   "object state. [groupId = {1}, artifactId = " +
-                                                  "{2}, verison = {3}]", this, ""+groupId,
+                                                  "{2}, version = {3}]", this, ""+groupId,
                                                   ""+artifactId, ""+version));
             }
             return string.Join(Constants.STRING_KEY_BINDER,
@@ -151,7 +151,7 @@ public string GenerateUniqueKey() {
     [XmlRoot("registry")]
     public class Registry : PackageManagerLabeledModel<Registry> {
         /// <summary>
-        /// When was this registry last updated in epoc time.
+        /// When was this registry last updated in epoch time.
         /// </summary>
         [XmlElement("lastUpdated")]
         public long lastUpdated;
@@ -174,7 +174,7 @@ public class Modules : PackageManagerModel<Modules> {
         /// 2) An absolute Uri to a location of a packaged plugin's package-manifest.xml
         ///
         /// Note: It is permitted to mix representations in a registry model. Meaning you can have
-        /// a mix of groupId representations and absolute Uri repesentations in the same registry.
+        /// a mix of groupId representations and absolute Uri representations in the same registry.
         /// </summary>
         [XmlElement("module")]
         public List<string> module = new List<string>();
@@ -264,7 +264,7 @@ public class Language : PackageManagerModel<Language> {
         public string name;
 
         /// <summary>
-        /// A short description of the plugin. Usually a single marketing sentance.
+        /// A short description of the plugin. Usually a single marketing sentence.
         /// </summary>
         [XmlElement("short")]
         public string shortDesc;

source/PackageManager/src/Views.cs

@@ -62,7 +62,7 @@ void Update() {
                         EditorUtility.DisplayDialog("Registry Location Not Valid",
                                                     string.Format(
                                                         "The registry cannot be added. An " +
-                                                        "error has occured using the provided " +
+                                                        "error has occurred using the provided " +
                                                         "location.\n\n{0}", rc),
                                                     "Ok");
                     }

source/PackageManagerTests/src/Google.PackageManager.Tests/ControllerTests.cs

@@ -180,7 +180,7 @@ public ResponseCode BlockingFetchAsBytes(Uri uri, out byte[] result) {
     }
 
     /// <summary>
-    /// Test case set that excercises the PackageManagerController.
+    /// Test case set that exercises the PackageManagerController.
     /// </summary>
     [TestFixture]
     public class ControllerTests {

source/PlayServicesResolver/src/AndroidSdkManager.cs

@@ -75,7 +75,7 @@ private string EscapeComponents(string packageName) {
                 if (match.Success) {
                     var prefix = packageName.Substring(0, match.Index);
                     var postfix = packageName.Substring(match.Index + match.Length);
-                    // Exclaimation marks are guaranteed - at the moment - to not be
+                    // Exclamation marks are guaranteed - at the moment - to not be
                     // part of a package name / path.
                     packageName = prefix + match.Value.Replace("-", "!") + postfix;
                 }

source/PlayServicesResolver/src/CommandLine.cs

@@ -655,7 +655,7 @@ public static string[] SplitLines(string multilineString)
         }
 
         /// <summary>
-        /// Format a command excecution error message.
+        /// Format a command execution error message.
         /// </summary>
         /// <param name="toolPath">Tool executed.</param>
         /// <param name="arguments">Arguments used to execute the tool.</param>

source/PlayServicesResolver/src/CommandLineDialog.cs

@@ -75,7 +75,7 @@ private int CountLines(string str)
 
             /// <summary>
             /// Called from RunCommandLine() tool to report the output of the currently
-            /// executing commmand.
+            /// executing command.
             /// </summary>
             /// <param name="process">Executing process.</param>
             /// <param name="stdin">Standard input stream.</param>

source/PlayServicesResolver/src/IResolver.cs

@@ -26,7 +26,7 @@ public interface IResolver
         /// </summary>
         /// <remarks>
         /// The resolver with the greatest version is used when resolving.
-        /// The value of the verison is calcuated using MakeVersion in DefaultResolver
+        /// The value of the version is calculated using MakeVersion in DefaultResolver
         /// </remarks>
         /// <seealso cref="DefaultResolver.MakeVersionNumber"/>
         int Version();

source/PlayServicesResolver/src/PlayServicesResolver.cs

@@ -796,7 +796,7 @@ private static bool CheckFilesForAutoResolution(HashSet<string> filesToCheck) {
 
         /// <summary>
         /// Called by Unity when all assets have been updated. This
-        /// is used to kick off resolving the dependendencies declared.
+        /// is used to kick off resolving the dependencies declared.
         /// </summary>
         /// <param name="importedAssets">Imported assets. (unused)</param>
         /// <param name="deletedAssets">Deleted assets. (unused)</param>
@@ -970,7 +970,7 @@ private static void Reresolve() {
         /// * com.my.app.service --> com.another.app.service
         /// * foo.com.my.app.service --> foo.com.my.app.service (unchanged)
         /// </param>
-        /// <param name="path">Path of this node in the hierachy of nodes. For example:
+        /// <param name="path">Path of this node in the hierarchy of nodes. For example:
         /// given node is "<c>" in "<a><b><c>" this should be "a/b/c".  If this
         /// value is null the name of the current node is used.</param>
         /// <returns>true if any replacements are applied, false otherwise.</returns>

source/PlayServicesResolver/src/ResolverVer1_1.cs

@@ -51,7 +51,7 @@ private class AarExplodeData
             public string targetAbis = ABI_UNIVERSAL;
             // Whether gradle is selected as the build system.
             public bool gradleBuildSystem = PlayServicesResolver.GradleBuildEnabled;
-            // Whether gradle export is enabeld.
+            // Whether gradle export is enabled.
             public bool gradleExport = PlayServicesResolver.GradleProjectExportEnabled;
             // AAR version that should be ignored when attempting to overwrite an existing
             // dependency.  This is reset when the dependency is updated to a version different
@@ -396,7 +396,7 @@ private void SaveAarExplodeCache()
         /// Version of the resolver. - 1.1.0
         /// </summary>
         /// <remarks>The resolver with the greatest version is used when resolving.
-        /// The value of the verison is calcuated using MakeVersion in DefaultResolver</remarks>
+        /// The value of the version is calculated using MakeVersion in DefaultResolver</remarks>
         /// <seealso cref="DefaultResolver.MakeVersionNumber"></seealso>
         public override int Version()
         {

source/PlayServicesResolver/src/SettingsDialog.cs

@@ -182,7 +182,7 @@ internal static bool VerboseLogging {
 
         internal static string ValidatePackageDir(string directory) {
             // Make sure the package directory starts with the same name.
-            // This is case insentitive to handle cases where developers rename Unity
+            // This is case insensitive to handle cases where developers rename Unity
             // project directories on Windows (which has a case insensitive file system by
             // default) then they use the project on OSX / Linux.
             if (!directory.ToLowerInvariant().StartsWith(AndroidPluginsDir.ToLower())) {