Skip to content

Commit 56f4524

Browse files
Improve comments in OpenApiReferencableExtensions
1 parent 23c8417 commit 56f4524

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

src/Microsoft.OpenApi/Extensions/OpenApiReferencableExtensions.cs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,20 @@
88
using Microsoft.OpenApi.Interfaces;
99
using Microsoft.OpenApi.Models;
1010
using Microsoft.OpenApi.Properties;
11-
using Microsoft.OpenApi.Services;
12-
using Microsoft.OpenApi.Validations;
1311

1412
namespace Microsoft.OpenApi.Extensions
1513
{
1614
/// <summary>
17-
/// TODO: tmpDbg comment
15+
/// Extension methods for resolving references on <see cref="IOpenApiReferenceable"/> elements.
1816
/// </summary>
1917
public static class OpenApiReferencableExtensions
2018
{
2119
/// <summary>
2220
/// TODO: tmpDbg comment
2321
/// </summary>
24-
/// <param name="element">Element to validate</param>
25-
/// <param name="ruleSet">Optional set of rules to use for validation</param>
26-
/// <returns>An IEnumerable of errors. This function will never return null.</returns>
22+
/// <param name="element">The referencable Open API element on which to apply the JSON pointer</param>
23+
/// <param name="jsonPointer">a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901).</param>
24+
/// <returns>The element pointed to by the JSON pointer.</returns>
2725
public static IOpenApiReferenceable ResolveReference(this IOpenApiReferenceable element, string jsonPointer)
2826
{
2927
if (jsonPointer == "/")

0 commit comments

Comments
 (0)