From c59fd1ba86676bc3182767bc9db285aec586f42f Mon Sep 17 00:00:00 2001 From: Simon Cropp Date: Fri, 6 Oct 2023 21:19:01 +1100 Subject: [PATCH] fix comment typos --- src/Microsoft.OpenApi.Readers/Interface/IStreamLoader.cs | 2 +- src/Microsoft.OpenApi.Readers/ParsingContext.cs | 4 ++-- src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs | 2 +- src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs | 4 ++-- src/Microsoft.OpenApi/Interfaces/IOpenApiExtension.cs | 2 +- src/Microsoft.OpenApi/Interfaces/IOpenApiSerializable.cs | 2 +- src/Microsoft.OpenApi/Models/OpenApiDocument.cs | 2 +- src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs | 2 +- src/Microsoft.OpenApi/Services/OpenApiWalker.cs | 2 +- src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs | 2 +- src/Microsoft.OpenApi/Validations/IValidationContext.cs | 2 +- src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs | 2 +- src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs | 4 ++-- .../Microsoft.OpenApi.Readers.Tests/DefaultSettingsFixture.cs | 2 +- test/Microsoft.OpenApi.Tests/DefaultSettingsFixture.cs | 2 +- 15 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/Microsoft.OpenApi.Readers/Interface/IStreamLoader.cs b/src/Microsoft.OpenApi.Readers/Interface/IStreamLoader.cs index b3c0c4613..f69ae474a 100644 --- a/src/Microsoft.OpenApi.Readers/Interface/IStreamLoader.cs +++ b/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. /// /// Identifier of some source of an OpenAPI Description - /// A data objext that can be processed by a reader to generate an + /// A data object that can be processed by a reader to generate an Task LoadAsync(Uri uri); /// diff --git a/src/Microsoft.OpenApi.Readers/ParsingContext.cs b/src/Microsoft.OpenApi.Readers/ParsingContext.cs index 93a7d6564..eb7459d10 100644 --- a/src/Microsoft.OpenApi.Readers/ParsingContext.cs +++ b/src/Microsoft.OpenApi.Readers/ParsingContext.cs @@ -39,7 +39,7 @@ public class ParsingContext /// /// Create Parsing Context /// - /// Provide instance for diagnotic object for collecting and accessing information about the parsing. + /// Provide instance for diagnostic object for collecting and accessing information about the parsing. public ParsingContext(OpenApiDiagnostic diagnostic) { Diagnostic = diagnostic; @@ -165,7 +165,7 @@ public T GetFromTempStorage(string key, object scope = null) } /// - /// Sets the temporary storge for this key and value. + /// Sets the temporary storage for this key and value. /// public void SetTempStorage(string key, object value, object scope = null) { diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs index 20490aca7..0a0495ea4 100644 --- a/src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs +++ b/src/Microsoft.OpenApi.Readers/V2/OpenApiV2VersionService.cs @@ -24,7 +24,7 @@ internal class OpenApiV2VersionService : IOpenApiVersionService /// /// Create Parsing Context /// - /// Provide instance for diagnotic object for collecting and accessing information about the parsing. + /// Provide instance for diagnostic object for collecting and accessing information about the parsing. public OpenApiV2VersionService(OpenApiDiagnostic diagnostic) { Diagnostic = diagnostic; diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs index 011680d3d..23bf82c7e 100644 --- a/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs +++ b/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs @@ -26,7 +26,7 @@ internal class OpenApiV3VersionService : IOpenApiVersionService /// /// Create Parsing Context /// - /// Provide instance for diagnotic object for collecting and accessing information about the parsing. + /// Provide instance for diagnostic object for collecting and accessing information about the parsing. public OpenApiV3VersionService(OpenApiDiagnostic diagnostic) { Diagnostic = diagnostic; @@ -68,7 +68,7 @@ public OpenApiV3VersionService(OpenApiDiagnostic diagnostic) /// Parse the string to a object. /// /// The URL of the reference - /// The type of object refefenced based on the context of the reference + /// The type of object referenced based on the context of the reference public OpenApiReference ConvertToOpenApiReference( string reference, ReferenceType? type) diff --git a/src/Microsoft.OpenApi/Interfaces/IOpenApiExtension.cs b/src/Microsoft.OpenApi/Interfaces/IOpenApiExtension.cs index ad6f2c0e5..18f598e44 100644 --- a/src/Microsoft.OpenApi/Interfaces/IOpenApiExtension.cs +++ b/src/Microsoft.OpenApi/Interfaces/IOpenApiExtension.cs @@ -6,7 +6,7 @@ namespace Microsoft.OpenApi.Interfaces { /// - /// Interface requuired for implementing any custom extension + /// Interface required for implementing any custom extension /// public interface IOpenApiExtension { diff --git a/src/Microsoft.OpenApi/Interfaces/IOpenApiSerializable.cs b/src/Microsoft.OpenApi/Interfaces/IOpenApiSerializable.cs index 6f5b1bd09..a3b22bd08 100644 --- a/src/Microsoft.OpenApi/Interfaces/IOpenApiSerializable.cs +++ b/src/Microsoft.OpenApi/Interfaces/IOpenApiSerializable.cs @@ -6,7 +6,7 @@ namespace Microsoft.OpenApi.Interfaces { /// - /// Represents an Open API element that comes with serialzation functionality. + /// Represents an Open API element that comes with serialization functionality. /// public interface IOpenApiSerializable : IOpenApiElement { diff --git a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs index b3cea1a8d..c2fa42890 100644 --- a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs +++ b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs @@ -308,7 +308,7 @@ private static void WriteHostInfoV2(IOpenApiWriter writer, IList 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 diff --git a/src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs b/src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs index 87dd07b81..52f2207ed 100644 --- a/src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs +++ b/src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs @@ -31,7 +31,7 @@ public virtual void Enter(string segment) } /// - /// Exit from path context elevel. Enter and Exit calls should be matched. + /// Exit from path context level. Enter and Exit calls should be matched. /// public virtual void Exit() { diff --git a/src/Microsoft.OpenApi/Services/OpenApiWalker.cs b/src/Microsoft.OpenApi/Services/OpenApiWalker.cs index ddda44218..4811f647c 100644 --- a/src/Microsoft.OpenApi/Services/OpenApiWalker.cs +++ b/src/Microsoft.OpenApi/Services/OpenApiWalker.cs @@ -896,7 +896,7 @@ internal void Walk(IList schemas) return; } - // Visit Schemass + // Visit Schemas if (schemas != null) { for (int i = 0; i < schemas.Count; i++) diff --git a/src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs b/src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs index dc7ae75d3..eda6e1a1d 100644 --- a/src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs +++ b/src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs @@ -101,7 +101,7 @@ public void AddFragment(string location, IOpenApiReferenceable fragment) } /// - /// 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. /// /// /// diff --git a/src/Microsoft.OpenApi/Validations/IValidationContext.cs b/src/Microsoft.OpenApi/Validations/IValidationContext.cs index fe93b2a58..73b1fec06 100644 --- a/src/Microsoft.OpenApi/Validations/IValidationContext.cs +++ b/src/Microsoft.OpenApi/Validations/IValidationContext.cs @@ -27,7 +27,7 @@ public interface IValidationContext void Enter(string segment); /// - /// Exit from path context elevel. Enter and Exit calls should be matched. + /// Exit from path context level. Enter and Exit calls should be matched. /// void Exit(); diff --git a/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs b/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs index 16958727d..5254288f3 100644 --- a/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs +++ b/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs @@ -20,7 +20,7 @@ public abstract class OpenApiWriterBase : IOpenApiWriter public OpenApiWriterSettings Settings { get; set; } /// - /// The indentation string to prepand to each line for each indentation level. + /// The indentation string to prepend to each line for each indentation level. /// protected const string IndentationString = " "; diff --git a/src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs b/src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs index 8f4a866ae..a0fa62eae 100644 --- a/src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs +++ b/src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs @@ -132,7 +132,7 @@ public static void WriteProperty(this IOpenApiWriter writer, string name, T v /// The Open API writer. /// The property name. /// The property value. - /// The proprety value writer action. + /// The property value writer action. public static void WriteOptionalObject( this IOpenApiWriter writer, string name, @@ -158,7 +158,7 @@ public static void WriteOptionalObject( /// The Open API writer. /// The property name. /// The property value. - /// The proprety value writer action. + /// The property value writer action. public static void WriteRequiredObject( this IOpenApiWriter writer, string name, diff --git a/test/Microsoft.OpenApi.Readers.Tests/DefaultSettingsFixture.cs b/test/Microsoft.OpenApi.Readers.Tests/DefaultSettingsFixture.cs index a694d17b0..ed8072ba6 100644 --- a/test/Microsoft.OpenApi.Readers.Tests/DefaultSettingsFixture.cs +++ b/test/Microsoft.OpenApi.Readers.Tests/DefaultSettingsFixture.cs @@ -11,7 +11,7 @@ namespace Microsoft.OpenApi.Readers.Tests public class DefaultSettingsFixture { /// - /// Initializes an intance of . + /// Initializes an instance of . /// public DefaultSettingsFixture() { diff --git a/test/Microsoft.OpenApi.Tests/DefaultSettingsFixture.cs b/test/Microsoft.OpenApi.Tests/DefaultSettingsFixture.cs index 3a0b8aabe..d2afed0c6 100644 --- a/test/Microsoft.OpenApi.Tests/DefaultSettingsFixture.cs +++ b/test/Microsoft.OpenApi.Tests/DefaultSettingsFixture.cs @@ -11,7 +11,7 @@ namespace Microsoft.OpenApi.Tests public class DefaultSettingsFixture { /// - /// Initializes an intance of . + /// Initializes an instance of . /// public DefaultSettingsFixture() {