Skip to content

Commit a4933ef

Browse files
committed
Update input doc comments
1 parent 955f7fb commit a4933ef

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public ReadResult Read(MemoryStream input,
4949
if (settings is null) throw new ArgumentNullException(nameof(settings));
5050
JsonNode jsonNode;
5151

52-
// Parse the YAML text in the TextReader into a sequence of JsonNodes
52+
// Parse the YAML text in the stream into a sequence of JsonNodes
5353
try
5454
{
5555
using var stream = new StreamReader(input, default, true, -1, settings.LeaveStreamOpen);

src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public interface IOpenApiReader
1717
/// <summary>
1818
/// Async method to reads the stream and parse it into an Open API document.
1919
/// </summary>
20-
/// <param name="input">The TextReader input.</param>
20+
/// <param name="input">The stream input.</param>
2121
/// <param name="settings"> The OpenApi reader settings.</param>
2222
/// <param name="cancellationToken">Propagates notification that an operation should be cancelled.</param>
2323
/// <returns></returns>

src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public class OpenApiJsonReader : IOpenApiReader
2323
/// <summary>
2424
/// Reads the memory stream input and parses it into an Open API document.
2525
/// </summary>
26-
/// <param name="input">TextReader containing OpenAPI description to parse.</param>
26+
/// <param name="input">Memory stream containing OpenAPI description to parse.</param>
2727
/// <param name="settings">The Reader settings to be used during parsing.</param>
2828
/// <returns></returns>
2929
public ReadResult Read(MemoryStream input,
@@ -33,7 +33,7 @@ public ReadResult Read(MemoryStream input,
3333
var diagnostic = new OpenApiDiagnostic();
3434
settings ??= new OpenApiReaderSettings();
3535

36-
// Parse the JSON text in the TextReader into JsonNodes
36+
// Parse the JSON text in the stream into JsonNodes
3737
try
3838
{
3939
jsonNode = JsonNode.Parse(input);
@@ -106,7 +106,7 @@ public ReadResult Read(JsonNode jsonNode,
106106
/// <summary>
107107
/// Reads the stream input asynchronously and parses it into an Open API document.
108108
/// </summary>
109-
/// <param name="input">TextReader containing OpenAPI description to parse.</param>
109+
/// <param name="input">Memory stream containing OpenAPI description to parse.</param>
110110
/// <param name="settings">The Reader settings to be used during parsing.</param>
111111
/// <param name="cancellationToken">Propagates notifications that operations should be cancelled.</param>
112112
/// <returns></returns>
@@ -118,7 +118,7 @@ public async Task<ReadResult> ReadAsync(Stream input,
118118
var diagnostic = new OpenApiDiagnostic();
119119
settings ??= new OpenApiReaderSettings();
120120

121-
// Parse the JSON text in the TextReader into JsonNodes
121+
// Parse the JSON text in the stream into JsonNodes
122122
try
123123
{
124124
jsonNode = await JsonNode.ParseAsync(input, cancellationToken: cancellationToken).ConfigureAwait(false);
@@ -195,7 +195,5 @@ public T ReadFragment<T>(JsonNode input,
195195

196196
return (T)element;
197197
}
198-
199-
200198
}
201199
}

0 commit comments

Comments
 (0)