Skip to content

Commit a82a451

Browse files
committed
XML comments update
1 parent f13906d commit a82a451

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

src/Microsoft.OpenApi/Services/OpenApiUrlSpaceNode.cs

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) Microsoft Corporation. All rights reserved.
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
22
// Licensed under the MIT license.
33

44
using System.Collections.Generic;
@@ -132,11 +132,12 @@ private static string GetHash(HashAlgorithm hashAlgorithm, string input)
132132
}
133133

134134
/// <summary>
135-
/// Creates a structured directory of nodes from the paths of an OpenAPI document.
135+
/// Creates a structured directory of <see cref="OpenApiUrlSpaceNode"/> nodes from the paths of an OpenAPI document.
136136
/// </summary>
137137
/// <param name="doc">The OpenAPI document.</param>
138-
/// <param name="label">Name tag for labelling the nodes in the directory structure.</param>
139-
/// <returns>The root node of the created directory structure.</returns>
138+
/// <param name="label">Name tag for labelling the <see cref="OpenApiUrlSpaceNode"/> nodes
139+
/// in the directory structure.</param>
140+
/// <returns>The root node of the created <see cref="OpenApiUrlSpaceNode"/> directory structure.</returns>
140141
public static OpenApiUrlSpaceNode Create(OpenApiDocument doc, string label = "")
141142
{
142143
OpenApiUrlSpaceNode root = null;
@@ -155,10 +156,11 @@ public static OpenApiUrlSpaceNode Create(OpenApiDocument doc, string label = "")
155156
}
156157

157158
/// <summary>
158-
/// Retrieves the paths from an OpenAPI document and appends the items to a node.
159+
/// Retrieves the paths from an OpenAPI document and appends the items to an <see cref="OpenApiUrlSpaceNode"/> node.
159160
/// </summary>
160161
/// <param name="doc">The OpenAPI document.</param>
161-
/// <param name="label">Name tag for labelling the nodes in the directory structure.</param>
162+
/// <param name="label">Name tag for labelling related <see cref="OpenApiUrlSpaceNode"/>
163+
/// nodes in the directory structure.</param>
162164
public void Attach(OpenApiDocument doc, string label)
163165
{
164166
var paths = doc?.Paths;
@@ -172,12 +174,12 @@ public void Attach(OpenApiDocument doc, string label)
172174
}
173175

174176
/// <summary>
175-
/// Appends an OpenAPI path and the PathItems to a node.
177+
/// Appends an OpenAPI path and the PathItems to an <see cref="OpenApiUrlSpaceNode"/> node.
176178
/// </summary>
177179
/// <param name="path">An OpenAPI path.</param>
178180
/// <param name="pathItem">Path Item object that describes the operations available on an OpenAPI path.</param>
179-
/// <param name="label">A name tag for labelling the node.</param>
180-
/// <returns>A node describing an OpenAPI path.</returns>
181+
/// <param name="label">A name tag for labelling the <see cref="OpenApiUrlSpaceNode"/> node.</param>
182+
/// <returns>An <see cref="OpenApiUrlSpaceNode"/> node describing an OpenAPI path.</returns>
181183
public OpenApiUrlSpaceNode Attach(string path, OpenApiPathItem pathItem, string label)
182184
{
183185
if (path.StartsWith("/"))
@@ -190,13 +192,13 @@ public OpenApiUrlSpaceNode Attach(string path, OpenApiPathItem pathItem, string
190192
}
191193

192194
/// <summary>
193-
/// Assembles the constituent properties of a node.
195+
/// Assembles the constituent properties of an <see cref="OpenApiUrlSpaceNode"/> node.
194196
/// </summary>
195197
/// <param name="segments">IEnumerable subdirectories of a relative path.</param>
196198
/// <param name="pathItem">Path Item object that describes the operations available on an OpenAPI path.</param>
197-
/// <param name="label">A name tag for labelling the node.</param>
199+
/// <param name="label">A name tag for labelling the <see cref="OpenApiUrlSpaceNode"/> node.</param>
198200
/// <param name="currentPath">The relative path of a node.</param>
199-
/// <returns>A node with all constituent properties assembled.</returns>
201+
/// <returns>An <see cref="OpenApiUrlSpaceNode"/> node with all constituent properties assembled.</returns>
200202
private OpenApiUrlSpaceNode Attach(IEnumerable<string> segments, OpenApiPathItem pathItem, string label, string currentPath)
201203
{
202204
var segment = segments.FirstOrDefault();

0 commit comments

Comments
 (0)