Skip to content

Commit cf7002a

Browse files
committed
Fix warnings
1 parent 29b8144 commit cf7002a

File tree

7 files changed

+15
-6
lines changed

7 files changed

+15
-6
lines changed

src/Microsoft.OpenApi.Readers/ParsingContext.cs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,15 @@ public class ParsingContext
3030
internal List<OpenApiTag> Tags { get; private set; } = new List<OpenApiTag>();
3131
internal Uri BaseUrl { get; set; }
3232

33+
/// <summary>
34+
/// Diagnostic object that returns metadata about the parsing process.
35+
/// </summary>
3336
public OpenApiDiagnostic Diagnostic { get; }
3437

38+
/// <summary>
39+
/// Create Parsing Context
40+
/// </summary>
41+
/// <param name="diagnostic">Provide instance for diagnotic object for collecting and accessing information about the parsing.</param>
3542
public ParsingContext(OpenApiDiagnostic diagnostic)
3643
{
3744
Diagnostic = diagnostic;
@@ -41,7 +48,6 @@ public ParsingContext(OpenApiDiagnostic diagnostic)
4148
/// Initiates the parsing process. Not thread safe and should only be called once on a parsing context
4249
/// </summary>
4350
/// <param name="yamlDocument">Yaml document to parse.</param>
44-
/// <param name="diagnostic">Diagnostic object which will return diagnostic results of the operation.</param>
4551
/// <returns>An OpenApiDocument populated based on the passed yamlDocument </returns>
4652
internal OpenApiDocument Parse(YamlDocument yamlDocument)
4753
{
@@ -77,7 +83,6 @@ internal OpenApiDocument Parse(YamlDocument yamlDocument)
7783
/// </summary>
7884
/// <param name="yamlDocument"></param>
7985
/// <param name="version">OpenAPI version of the fragment</param>
80-
/// <param name="diagnostic">Diagnostic object which will return diagnostic results of the operation.</param>
8186
/// <returns>An OpenApiDocument populated based on the passed yamlDocument </returns>
8287
internal T ParseFragment<T>(YamlDocument yamlDocument, OpenApiSpecVersion version) where T : IOpenApiElement
8388
{

src/Microsoft.OpenApi/Any/OpenApiString.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ public class OpenApiString : OpenApiPrimitive<string>
1414
/// Initializes the <see cref="OpenApiString"/> class.
1515
/// </summary>
1616
/// <param name="value"></param>
17+
/// <param name="isExplicit">Used to indicate if a string is quoted.</param>
1718
public OpenApiString(string value, bool isExplicit = false)
1819
: base(value)
1920
{

src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ public static void SerializeAsYaml<T>(this T element, Stream stream, OpenApiSpec
5050
/// <param name="stream">The given stream.</param>
5151
/// <param name="specVersion">The Open API specification version.</param>
5252
/// <param name="format">The output format (JSON or YAML).</param>
53+
/// <param name="settings">Provide configuration settings for controlling writing output</param>
5354
public static void Serialize<T>(
5455
this T element,
5556
Stream stream,

src/Microsoft.OpenApi/Services/LoopDetector.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ internal class LoopDetector
1313
/// <summary>
1414
/// Maintain history of traversals to avoid stack overflows from cycles
1515
/// </summary>
16-
/// <param name="loopId">Any unique identifier for a stack.</param>
1716
/// <param name="key">Identifier used for current context.</param>
1817
/// <returns>If method returns false a loop was detected and the key is not added.</returns>
1918
public bool PushLoop<T>(T key)
@@ -39,7 +38,6 @@ public bool PushLoop<T>(T key)
3938
/// <summary>
4039
/// Exit from the context in cycle detection
4140
/// </summary>
42-
/// <param name="loopid">Identifier of loop</param>
4341
public void PopLoop<T>()
4442
{
4543
if (_loopStacks[typeof(T)].Count > 0)
@@ -65,7 +63,6 @@ public void SaveLoop<T>(T loop)
6563
/// <summary>
6664
/// Reset loop tracking stack
6765
/// </summary>
68-
/// <param name="loopid">Identifier of loop to clear</param>
6966
internal void ClearLoop<T>()
7067
{
7168
_loopStacks[typeof(T)].Clear();

src/Microsoft.OpenApi/Services/OpenApiDifferenceOperation.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
namespace Microsoft.OpenApi.Services
55
{
6+
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
7+
68
/// <summary>
79
/// The open api difference operation.
810
/// </summary>
@@ -12,4 +14,6 @@ public enum OpenApiDifferenceOperation
1214
Remove,
1315
Update
1416
}
17+
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
18+
1519
}

src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ public class OpenApiJsonWriter : OpenApiWriterBase
1414
/// Initializes a new instance of the <see cref="OpenApiJsonWriter"/> class.
1515
/// </summary>
1616
/// <param name="textWriter">The text writer.</param>
17+
/// <param name="settings">Settings for controlling how the OpenAPI document will be written out.</param>
1718
public OpenApiJsonWriter(TextWriter textWriter, OpenApiWriterSettings settings = null) : base(textWriter, settings)
1819
{
1920
}

test/Microsoft.OpenApi.SmokeTests/ApiGurus.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ JToken GetProp(JToken obj, string prop)
7171
}
7272

7373
// Disable as some APIs are currently invalid [Theory(DisplayName = "APIs.guru")]
74-
[MemberData(nameof(GetSchemas))]
74+
// [MemberData(nameof(GetSchemas))]
7575
public async Task EnsureThatICouldParse(string url)
7676
{
7777
var response = await _httpClient.GetAsync(url);

0 commit comments

Comments
 (0)