Skip to content

Commit

Permalink
fix comment typos
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp committed Oct 6, 2023
1 parent 94c811e commit c59fd1b
Show file tree
Hide file tree
Showing 15 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi.Readers/Interface/IStreamLoader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.OpenApi.Readers/ParsingContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Interfaces/IOpenApiExtension.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Interfaces/IOpenApiSerializable.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Models/OpenApiDocument.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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()
{
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Services/OpenApiWalker.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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++)
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Validations/IValidationContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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 = " ";

Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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()
{
Expand Down
2 changes: 1 addition & 1 deletion test/Microsoft.OpenApi.Tests/DefaultSettingsFixture.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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()
{
Expand Down

0 comments on commit c59fd1b

Please sign in to comment.