Skip to content

Commit 02b0606

Browse files
carlossanlopmairaw
authored andcommitted
Document System.IO.Enumeration.FileSystemEnumerable (#3413)
* Document System.IO.Enumeration.FileSystemEnumerable * minor edits * suggestions by mairaw * edits * remove internal implementation detail
1 parent df7cd57 commit 02b0606

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

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

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,17 @@
5454
<Parameter Name="options" Type="System.IO.EnumerationOptions" />
5555
</Parameters>
5656
<Docs>
57-
<param name="directory">To be added.</param>
58-
<param name="transform">To be added.</param>
59-
<param name="options">To be added.</param>
60-
<summary>To be added.</summary>
61-
<remarks>To be added.</remarks>
57+
<param name="directory">The path of the directory where the enumeration will be performed.</param>
58+
<param name="transform">A delegate method for transforming raw find data into a result.</param>
59+
<param name="options">An object describing the enumeration options.</param>
60+
<summary>Initializes a new instance of the <see cref="T:System.IO.Enumeration.FileSystemEnumerable`1" /> class with specific search and filtering options.</summary>
61+
<remarks>To be added.</remarks>
62+
<exception cref="T:System.ArgumentNullException"><paramref name="directory" /> or <paramref name="transform" /> is <see langword="null" />.</exception>
63+
<exception cref="T:System.ArgumentException">The <paramref name="directory" /> path is empty.
64+
65+
-or-
66+
67+
<paramref name="directory" /> contains a null character "\0".</exception>
6268
</Docs>
6369
</Member>
6470
<Member MemberName="GetEnumerator">

0 commit comments

Comments
 (0)