Merge pull request #1407 from SimonCropp/fix-comment-typos

fix comment typos

src/Microsoft.OpenApi.Readers/Interface/IStreamLoader.cs

@@ -17,7 +17,7 @@ public interface IStreamLoader
         /// Use Uri to locate data and convert into an input object.
         /// </summary>
         /// <param name="uri">Identifier of some source of an OpenAPI Description</param>
-        /// <returns>A data objext that can be processed by a reader to generate an <see cref="OpenApiDocument"/></returns>
+        /// <returns>A data object that can be processed by a reader to generate an <see cref="OpenApiDocument"/></returns>
         Task<Stream> LoadAsync(Uri uri);
 
         /// <summary>

src/Microsoft.OpenApi.Readers/ParsingContext.cs

@@ -39,7 +39,7 @@ public class ParsingContext
         /// <summary>
         /// Create Parsing Context
         /// </summary>
-        /// <param name="diagnostic">Provide instance for diagnotic object for collecting and accessing information about the parsing.</param>
+        /// <param name="diagnostic">Provide instance for diagnostic object for collecting and accessing information about the parsing.</param>
         public ParsingContext(OpenApiDiagnostic diagnostic)
         {
             Diagnostic = diagnostic;
@@ -165,7 +165,7 @@ public T GetFromTempStorage<T>(string key, object scope = null)
         }
 
         /// <summary>
-        /// Sets the temporary storge for this key and value.
+        /// Sets the temporary storage for this key and value.
         /// </summary>
         public void SetTempStorage(string key, object value, object scope = null)
         {

src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs

@@ -24,7 +24,7 @@ internal class OpenApiV2VersionService : IOpenApiVersionService
         /// <summary>
         /// Create Parsing Context
         /// </summary>
-        /// <param name="diagnostic">Provide instance for diagnotic object for collecting and accessing information about the parsing.</param>
+        /// <param name="diagnostic">Provide instance for diagnostic object for collecting and accessing information about the parsing.</param>
         public OpenApiV2VersionService(OpenApiDiagnostic diagnostic)
         {
             Diagnostic = diagnostic;

src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs

@@ -26,7 +26,7 @@ internal class OpenApiV3VersionService : IOpenApiVersionService
         /// <summary>
         /// Create Parsing Context
         /// </summary>
-        /// <param name="diagnostic">Provide instance for diagnotic object for collecting and accessing information about the parsing.</param>
+        /// <param name="diagnostic">Provide instance for diagnostic object for collecting and accessing information about the parsing.</param>
         public OpenApiV3VersionService(OpenApiDiagnostic diagnostic)
         {
             Diagnostic = diagnostic;
@@ -68,7 +68,7 @@ public OpenApiV3VersionService(OpenApiDiagnostic diagnostic)
         /// Parse the string to a <see cref="OpenApiReference"/> object.
         /// </summary>
         /// <param name="reference">The URL of the reference</param>
-        /// <param name="type">The type of object refefenced based on the context of the reference</param>
+        /// <param name="type">The type of object referenced based on the context of the reference</param>
         public OpenApiReference ConvertToOpenApiReference(
             string reference,
             ReferenceType? type)

src/Microsoft.OpenApi/Interfaces/IOpenApiExtension.cs

@@ -6,7 +6,7 @@
 namespace Microsoft.OpenApi.Interfaces
 {
     /// <summary>
-    /// Interface requuired for implementing any custom extension
+    /// Interface required for implementing any custom extension
     /// </summary>
     public interface IOpenApiExtension
     {

src/Microsoft.OpenApi/Interfaces/IOpenApiSerializable.cs

@@ -6,7 +6,7 @@
 namespace Microsoft.OpenApi.Interfaces
 {
     /// <summary>
-    /// Represents an Open API element that comes with serialzation functionality.
+    /// Represents an Open API element that comes with serialization functionality.
     /// </summary>
     public interface IOpenApiSerializable : IOpenApiElement
     {

src/Microsoft.OpenApi/Models/OpenApiDocument.cs

@@ -308,7 +308,7 @@ private static void WriteHostInfoV2(IOpenApiWriter writer, IList<OpenApiServer>
             var serverUrl = ParseServerUrl(servers.First());
 
             // Divide the URL in the Url property into host and basePath required in OpenAPI V2
-            // The Url property cannotcontain path templating to be valid for V2 serialization.
+            // The Url property cannot contain path templating to be valid for V2 serialization.
             var firstServerUrl = new Uri(serverUrl, UriKind.RelativeOrAbsolute);
 
             // host

src/Microsoft.OpenApi/Models/OpenApiSecurityScheme.cs

@@ -205,7 +205,7 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
                     break;
 
                 case SecuritySchemeType.OAuth2:
-                    // These properties apply to ouauth2 type only.
+                    // These properties apply to oauth2 type only.
                     // flow
                     // authorizationUrl
                     // tokenUrl

src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs

@@ -242,7 +242,7 @@ public void WriteMermaid(TextWriter writer)
         }
 
         /// <summary>
-        /// Dictionary that maps a set of HTTP methods to HTML color.  Keys are sorted, uppercased, concatenated HTTP methods.
+        /// Dictionary that maps a set of HTTP methods to HTML color.  Keys are sorted, upper-cased, concatenated HTTP methods.
         /// </summary>
         public readonly static IReadOnlyDictionary<string, MermaidNodeStyle> MermaidNodeStyles = new Dictionary<string, MermaidNodeStyle>(StringComparer.OrdinalIgnoreCase)
         {

src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs

@@ -31,7 +31,7 @@ public virtual void Enter(string segment)
         }
 
         /// <summary>
-        /// Exit from path context elevel.  Enter and Exit calls should be matched.
+        /// Exit from path context level.  Enter and Exit calls should be matched.
         /// </summary>
         public virtual void Exit()
         {

src/Microsoft.OpenApi/Services/OpenApiWalker.cs

@@ -896,7 +896,7 @@ internal void Walk(IList<OpenApiSchema> schemas)
                 return;
             }
 
-            // Visit Schemass
+            // Visit Schemas
             if (schemas != null)
             {
                 for (int i = 0; i < schemas.Count; i++)

src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs

@@ -101,7 +101,7 @@ public void AddFragment(string location, IOpenApiReferenceable fragment)
         }
 
         /// <summary>
-        /// Add a stream based artificat to the workspace.  Useful for images, examples, alternative schemas.
+        /// Add a stream based artifact to the workspace.  Useful for images, examples, alternative schemas.
         /// </summary>
         /// <param name="location"></param>
         /// <param name="artifact"></param>

src/Microsoft.OpenApi/Validations/IValidationContext.cs

@@ -27,7 +27,7 @@ public interface IValidationContext
         void Enter(string segment);
 
         /// <summary>
-        /// Exit from path context elevel.  Enter and Exit calls should be matched.
+        /// Exit from path context level.  Enter and Exit calls should be matched.
         /// </summary>
         void Exit();
 

src/Microsoft.OpenApi/Validations/Rules/OpenApiMediaTypeRules.cs

@@ -12,7 +12,7 @@ namespace Microsoft.OpenApi.Validations.Rules
     /// Removed this in v1.3 as a default rule as the OpenAPI specification does not require that example
     /// values validate against the schema.  Validating examples against the schema is particularly difficult
     /// as it requires parsing of the example using the schema as a guide.  This is not possible when the schema
-    /// is ref'd.  Even if we fix this issue, this rule should be treated as a warning, not an error
+    /// is referenced.  Even if we fix this issue, this rule should be treated as a warning, not an error
     /// Future versions of the validator should make that distinction.
     /// Future versions of the example parsers should not try an infer types.
     /// Example validation should be done as a separate post reading step so all schemas can be fully available.

src/Microsoft.OpenApi/Validations/ValidationRuleSet.cs

@@ -38,8 +38,8 @@ public IList<ValidationRule> FindRules(Type type)
         /// Gets the default validation rule sets.
         /// </summary>
         /// <remarks>
-        /// This is a method instead of a property to signal that a new default ruleset object is created
-        /// per call. Making this a property may be misleading callers to think the returned rulesets from multiple calls
+        /// This is a method instead of a property to signal that a new default rule-set object is created
+        /// per call. Making this a property may be misleading callers to think the returned rule-sets from multiple calls
         /// are the same objects.
         /// </remarks>
         public static ValidationRuleSet GetDefaultRuleSet()
@@ -56,7 +56,7 @@ public static ValidationRuleSet GetDefaultRuleSet()
         }
 
         /// <summary>
-        /// Return Ruleset with no rules
+        /// Return <see cref="ValidationRuleSet"/> with no rules
         /// </summary>
         public static ValidationRuleSet GetEmptyRuleSet()
         {

src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs

@@ -20,7 +20,7 @@ public abstract class OpenApiWriterBase : IOpenApiWriter
         public OpenApiWriterSettings Settings { get; set; }
 
         /// <summary>
-        /// The indentation string to prepand to each line for each indentation level.
+        /// The indentation string to prepend to each line for each indentation level.
         /// </summary>
         protected const string IndentationString = "  ";
 

src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs

@@ -132,7 +132,7 @@ public static void WriteProperty<T>(this IOpenApiWriter writer, string name, T v
         /// <param name="writer">The Open API writer.</param>
         /// <param name="name">The property name.</param>
         /// <param name="value">The property value.</param>
-        /// <param name="action">The proprety value writer action.</param>
+        /// <param name="action">The property value writer action.</param>
         public static void WriteOptionalObject<T>(
             this IOpenApiWriter writer,
             string name,
@@ -158,7 +158,7 @@ public static void WriteOptionalObject<T>(
         /// <param name="writer">The Open API writer.</param>
         /// <param name="name">The property name.</param>
         /// <param name="value">The property value.</param>
-        /// <param name="action">The proprety value writer action.</param>
+        /// <param name="action">The property value writer action.</param>
         public static void WriteRequiredObject<T>(
             this IOpenApiWriter writer,
             string name,

test/Microsoft.OpenApi.Readers.Tests/DefaultSettingsFixture.cs

@@ -11,7 +11,7 @@ namespace Microsoft.OpenApi.Readers.Tests
     public class DefaultSettingsFixture
     {
         /// <summary>
-        /// Initializes an intance of <see cref="DefaultSettingsFixture"/>.
+        /// Initializes an instance of <see cref="DefaultSettingsFixture"/>.
         /// </summary>
         public DefaultSettingsFixture()
         {

test/Microsoft.OpenApi.Tests/DefaultSettingsFixture.cs

@@ -11,7 +11,7 @@ namespace Microsoft.OpenApi.Tests
     public class DefaultSettingsFixture
     {
         /// <summary>
-        /// Initializes an intance of <see cref="DefaultSettingsFixture"/>.
+        /// Initializes an instance of <see cref="DefaultSettingsFixture"/>.
         /// </summary>
         public DefaultSettingsFixture()
         {