1
- // Copyright (c) Microsoft Corporation. All rights reserved.
1
+ // Copyright (c) Microsoft Corporation. All rights reserved.
2
2
// Licensed under the MIT license.
3
3
4
4
using System . Collections . Generic ;
@@ -132,11 +132,12 @@ private static string GetHash(HashAlgorithm hashAlgorithm, string input)
132
132
}
133
133
134
134
/// <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.
136
136
/// </summary>
137
137
/// <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>
140
141
public static OpenApiUrlSpaceNode Create ( OpenApiDocument doc , string label = "" )
141
142
{
142
143
OpenApiUrlSpaceNode root = null ;
@@ -155,10 +156,11 @@ public static OpenApiUrlSpaceNode Create(OpenApiDocument doc, string label = "")
155
156
}
156
157
157
158
/// <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.
159
160
/// </summary>
160
161
/// <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>
162
164
public void Attach ( OpenApiDocument doc , string label )
163
165
{
164
166
var paths = doc ? . Paths ;
@@ -172,12 +174,12 @@ public void Attach(OpenApiDocument doc, string label)
172
174
}
173
175
174
176
/// <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.
176
178
/// </summary>
177
179
/// <param name="path">An OpenAPI path.</param>
178
180
/// <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>
181
183
public OpenApiUrlSpaceNode Attach ( string path , OpenApiPathItem pathItem , string label )
182
184
{
183
185
if ( path . StartsWith ( "/" ) )
@@ -190,13 +192,13 @@ public OpenApiUrlSpaceNode Attach(string path, OpenApiPathItem pathItem, string
190
192
}
191
193
192
194
/// <summary>
193
- /// Assembles the constituent properties of a node.
195
+ /// Assembles the constituent properties of an <see cref="OpenApiUrlSpaceNode"/> node.
194
196
/// </summary>
195
197
/// <param name="segments">IEnumerable subdirectories of a relative path.</param>
196
198
/// <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>
198
200
/// <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>
200
202
private OpenApiUrlSpaceNode Attach ( IEnumerable < string > segments , OpenApiPathItem pathItem , string label , string currentPath )
201
203
{
202
204
var segment = segments . FirstOrDefault ( ) ;
0 commit comments