Skip to content

Commit 36515c4

Browse files
committed
Added comments
1 parent 5090c01 commit 36515c4

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
using System;
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT license.
3+
4+
using System;
25
using System.Collections.Generic;
36
using System.Linq;
47
using System.Text;
@@ -8,11 +11,17 @@
811
namespace Microsoft.OpenApi.Readers
912
{
1013
/// <summary>
11-
///
14+
/// Container object used for returning the result of reading an OpenAPI description.
1215
/// </summary>
1316
public class ReadResult
1417
{
18+
/// <summary>
19+
/// The parsed OpenApiDocument. Null will be returned if the document could not be parsed.
20+
/// </summary>
1521
public OpenApiDocument OpenApiDocument { set; get; }
22+
/// <summary>
23+
/// OpenApiDiagnostic contains the Errors reported while parsing
24+
/// </summary>
1625
public OpenApiDiagnostic OpenApiDiagnostic { set; get; }
1726
}
1827
}

test/Microsoft.OpenApi.Readers.Tests/OpenApiWorkspaceTests/OpenApiWorkspaceStreamTests.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ public async Task LoadTodoDocumentIntoWorkspace()
8383
Assert.Equal("string", referencedParameter.Schema.Type);
8484

8585
}
86+
87+
8688
}
8789

8890
public class MockLoader : IStreamLoader

0 commit comments

Comments
 (0)