Skip to content

Commit 68db478

Browse files
carlossanlopRon Petrusha
carlossanlop
authored and
Ron Petrusha
committed
Automatically port System.IO triple slash comments (#2675)
* Automatically port System.IO triple slash comments * suggestions by mairaw Co-Authored-By: Maira Wenzel <[email protected]> * Suggestions by JeremyKuhne and mairaw * Remark for Reset * remarks * Update FileSystemEntry.xml * broken link * Update FileSystemEnumerable`1+FindTransform.xml * Update FileSystemEnumerator`1.xml * Update FileSystemName.xml * Update PackUriHelper.xml * Update EnumerationOptions.xml * Update MatchCasing.xml * Update MatchType.xml * Fixed broken crefs
1 parent 36d8017 commit 68db478

10 files changed

+194
-120
lines changed

‎xml/System.IO.Enumeration/FileSystemEntry.xml

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
</Attribute>
2424
</Attributes>
2525
<Docs>
26-
<summary>To be added.</summary>
26+
<summary>Provides a lower level view of <see cref="T:System.IO.FileSystemInfo" /> to help process and filter find results.</summary>
2727
<remarks>To be added.</remarks>
2828
</Docs>
2929
<Members>
@@ -47,8 +47,8 @@
4747
<ReturnType>System.IO.FileAttributes</ReturnType>
4848
</ReturnValue>
4949
<Docs>
50-
<summary>To be added.</summary>
51-
<value>To be added.</value>
50+
<summary>Gets the attributes for this entry.</summary>
51+
<value>The attributes for this entry.</value>
5252
<remarks>To be added.</remarks>
5353
</Docs>
5454
</Member>
@@ -72,8 +72,8 @@
7272
<ReturnType>System.DateTimeOffset</ReturnType>
7373
</ReturnValue>
7474
<Docs>
75-
<summary>To be added.</summary>
76-
<value>To be added.</value>
75+
<summary>Gets the creation time for the entry or the oldest available time stamp if the operating system does not support creation time stamps.</summary>
76+
<value>The creation time for the entry.</value>
7777
<remarks>To be added.</remarks>
7878
</Docs>
7979
</Member>
@@ -97,8 +97,8 @@
9797
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
9898
</ReturnValue>
9999
<Docs>
100-
<summary>To be added.</summary>
101-
<value>To be added.</value>
100+
<summary>Gets the full path of the directory this entry resides in.</summary>
101+
<value>The full path of this entry's directory.</value>
102102
<remarks>To be added.</remarks>
103103
</Docs>
104104
</Member>
@@ -122,8 +122,8 @@
122122
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
123123
</ReturnValue>
124124
<Docs>
125-
<summary>To be added.</summary>
126-
<value>To be added.</value>
125+
<summary>Gets the file name for this entry.</summary>
126+
<value>This entry's file name.</value>
127127
<remarks>To be added.</remarks>
128128
</Docs>
129129
</Member>
@@ -147,8 +147,8 @@
147147
<ReturnType>System.Boolean</ReturnType>
148148
</ReturnValue>
149149
<Docs>
150-
<summary>To be added.</summary>
151-
<value>To be added.</value>
150+
<summary>Gets a value that indicates whether this entry is a directory.</summary>
151+
<value><see langword="true" /> if the entry is a directory; otherwise, <see langword="true" />.</value>
152152
<remarks>To be added.</remarks>
153153
</Docs>
154154
</Member>
@@ -172,8 +172,8 @@
172172
<ReturnType>System.Boolean</ReturnType>
173173
</ReturnValue>
174174
<Docs>
175-
<summary>To be added.</summary>
176-
<value>To be added.</value>
175+
<summary>Gets a value that indicates whether the file has the hidden attribute.</summary>
176+
<value><see langword="true" /> if the file has the hidden attribute; otherwise, <see langword="false" />.</value>
177177
<remarks>To be added.</remarks>
178178
</Docs>
179179
</Member>
@@ -197,8 +197,8 @@
197197
<ReturnType>System.DateTimeOffset</ReturnType>
198198
</ReturnValue>
199199
<Docs>
200-
<summary>To be added.</summary>
201-
<value>To be added.</value>
200+
<summary>Gets a datetime offset that represents the last access time in UTC.</summary>
201+
<value>The last access time in UTC.</value>
202202
<remarks>To be added.</remarks>
203203
</Docs>
204204
</Member>
@@ -222,8 +222,8 @@
222222
<ReturnType>System.DateTimeOffset</ReturnType>
223223
</ReturnValue>
224224
<Docs>
225-
<summary>To be added.</summary>
226-
<value>To be added.</value>
225+
<summary>Gets a datetime offset that represents the last write time in UTC.</summary>
226+
<value>The last write time in UTC.</value>
227227
<remarks>To be added.</remarks>
228228
</Docs>
229229
</Member>
@@ -247,8 +247,8 @@
247247
<ReturnType>System.Int64</ReturnType>
248248
</ReturnValue>
249249
<Docs>
250-
<summary>To be added.</summary>
251-
<value>To be added.</value>
250+
<summary>Gets the length of the file, in bytes.</summary>
251+
<value>The file length in bytes.</value>
252252
<remarks>To be added.</remarks>
253253
</Docs>
254254
</Member>
@@ -272,8 +272,8 @@
272272
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
273273
</ReturnValue>
274274
<Docs>
275-
<summary>To be added.</summary>
276-
<value>To be added.</value>
275+
<summary>Gets the root directory for the enumeration as specified in the constructor.</summary>
276+
<value>The original root directory.</value>
277277
<remarks>To be added.</remarks>
278278
</Docs>
279279
</Member>
@@ -297,8 +297,8 @@
297297
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
298298
</ReturnValue>
299299
<Docs>
300-
<summary>To be added.</summary>
301-
<value>To be added.</value>
300+
<summary>Gets the full path of the root directory used for the enumeration.</summary>
301+
<value>The root directory.</value>
302302
<remarks>To be added.</remarks>
303303
</Docs>
304304
</Member>
@@ -323,8 +323,8 @@
323323
</ReturnValue>
324324
<Parameters />
325325
<Docs>
326-
<summary>To be added.</summary>
327-
<returns>To be added.</returns>
326+
<summary>Converts the value of this instance to a <see cref="T:System.IO.FileSystemInfo" />.</summary>
327+
<returns>The value of this instance as a <see cref="T:System.IO.FileSystemInfo" />.</returns>
328328
<remarks>To be added.</remarks>
329329
</Docs>
330330
</Member>
@@ -349,8 +349,8 @@
349349
</ReturnValue>
350350
<Parameters />
351351
<Docs>
352-
<summary>To be added.</summary>
353-
<returns>To be added.</returns>
352+
<summary>Returns the full path of the find result.</summary>
353+
<returns>A string representing the full path.</returns>
354354
<remarks>To be added.</remarks>
355355
</Docs>
356356
</Member>
@@ -375,10 +375,10 @@
375375
</ReturnValue>
376376
<Parameters />
377377
<Docs>
378-
<summary>To be added.</summary>
379-
<returns>To be added.</returns>
378+
<summary>Returns the full path for the find results, based on the initially provided path.</summary>
379+
<returns>A string representing the full path.</returns>
380380
<remarks>To be added.</remarks>
381381
</Docs>
382382
</Member>
383383
</Members>
384-
</Type>
384+
</Type>

‎xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
<ReturnType>System.Boolean</ReturnType>
2727
</ReturnValue>
2828
<Docs>
29-
<param name="entry">To be added.</param>
30-
<summary>To be added.</summary>
31-
<returns>To be added.</returns>
29+
<param name="entry">A reference to the file system entry that will be evaluated with the predicate condition.</param>
30+
<summary>Encapsulates a method for filtering out find results.</summary>
31+
<returns><see langword="true" /> if the predicate condition is met; otherwise, <see langword="false" />.</returns>
3232
<remarks>To be added.</remarks>
3333
</Docs>
34-
</Type>
34+
</Type>

‎xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
<ReturnType>TResult</ReturnType>
2727
</ReturnValue>
2828
<Docs>
29-
<param name="entry">To be added.</param>
30-
<summary>To be added.</summary>
31-
<returns>To be added.</returns>
29+
<param name="entry">A reference to the file system entry that will be evaluated with the predicate condition.</param>
30+
<summary>Encapsulates a method for transforming raw find data into a result.</summary>
31+
<returns>An instance of the type that this delegate encapsulates.</returns>
3232
<remarks>To be added.</remarks>
3333
</Docs>
34-
</Type>
34+
</Type>

‎xml/System.IO.Enumeration/FileSystemEnumerable`1.xml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
</Interface>
2929
</Interfaces>
3030
<Docs>
31-
<typeparam name="TResult">To be added.</typeparam>
32-
<summary>To be added.</summary>
31+
<typeparam name="TResult">The type that this enumerable encapsulates.</typeparam>
32+
<summary>Allows utilizing custom filter predicates and transform delegates for enumeration purposes.</summary>
3333
<remarks>To be added.</remarks>
3434
</Docs>
3535
<Members>
@@ -85,8 +85,8 @@
8585
</ReturnValue>
8686
<Parameters />
8787
<Docs>
88-
<summary>To be added.</summary>
89-
<returns>To be added.</returns>
88+
<summary>Retrieves the enumerator for this type of result.</summary>
89+
<returns>An enumerator.</returns>
9090
<remarks>To be added.</remarks>
9191
</Docs>
9292
</Member>
@@ -110,8 +110,8 @@
110110
<ReturnType>System.IO.Enumeration.FileSystemEnumerable&lt;TResult&gt;+FindPredicate</ReturnType>
111111
</ReturnValue>
112112
<Docs>
113-
<summary>To be added.</summary>
114-
<value>To be added.</value>
113+
<summary>Gets or sets the predicate that can be used to verify if the TResults should be included.</summary>
114+
<value>The include predicate.</value>
115115
<remarks>To be added.</remarks>
116116
</Docs>
117117
</Member>
@@ -135,8 +135,8 @@
135135
<ReturnType>System.IO.Enumeration.FileSystemEnumerable&lt;TResult&gt;+FindPredicate</ReturnType>
136136
</ReturnValue>
137137
<Docs>
138-
<summary>To be added.</summary>
139-
<value>To be added.</value>
138+
<summary>Gets or sets the predicate that can be used to verify if the TResults should be recursed.</summary>
139+
<value>The recurse predicate.</value>
140140
<remarks>To be added.</remarks>
141141
</Docs>
142142
</Member>
@@ -163,10 +163,10 @@
163163
</ReturnValue>
164164
<Parameters />
165165
<Docs>
166-
<summary>To be added.</summary>
167-
<returns>To be added.</returns>
166+
<summary>Gets an enumerator that can be used to iterate.</summary>
167+
<returns>An enumerator instance.</returns>
168168
<remarks>To be added.</remarks>
169169
</Docs>
170170
</Member>
171171
</Members>
172-
</Type>
172+
</Type>

0 commit comments

Comments
 (0)