Skip to content

Commit 7745c94

Browse files
dsychinmairaw
authored andcommitted
Fix Directory.EnumerateFiles documentation is misleading (#3408)
* update misleading method description * update EnumerateFiles summary
1 parent 2164fee commit 7745c94

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

xml/System.IO/Directory.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ Directory::CreateDirectory("Public\\Html");
538538
<AssemblyVersion>4.1.0.0</AssemblyVersion>
539539
</AssemblyInfo>
540540
<Docs>
541-
<summary>Returns an enumerable collection of directory names that meet specified criteria.</summary>
541+
<summary>Returns an enumerable collection of directory full names that meet specified criteria.</summary>
542542
</Docs>
543543
</MemberGroup>
544544
<Member MemberName="EnumerateDirectories">
@@ -574,7 +574,7 @@ Directory::CreateDirectory("Public\\Html");
574574
</Parameters>
575575
<Docs>
576576
<param name="path">The relative or absolute path to the directory to search. This string is not case-sensitive.</param>
577-
<summary>Returns an enumerable collection of directory names in a specified path.</summary>
577+
<summary>Returns an enumerable collection of directory full names in a specified path.</summary>
578578
<returns>An enumerable collection of the full names (including paths) for the directories in the directory specified by <paramref name="path" />.</returns>
579579
<remarks>
580580
<format type="text/markdown"><![CDATA[
@@ -644,7 +644,7 @@ Directory::CreateDirectory("Public\\Html");
644644
<Docs>
645645
<param name="path">The relative or absolute path to the directory to search. This string is not case-sensitive.</param>
646646
<param name="searchPattern">The search string to match against the names of directories in <paramref name="path" />. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.</param>
647-
<summary>Returns an enumerable collection of directory names that match a search pattern in a specified path.</summary>
647+
<summary>Returns an enumerable collection of directory full names that match a search pattern in a specified path.</summary>
648648
<returns>An enumerable collection of the full names (including paths) for the directories in the directory specified by <paramref name="path" /> and that match the specified search pattern.</returns>
649649
<remarks>
650650
<format type="text/markdown"><![CDATA[
@@ -771,7 +771,7 @@ Directory::CreateDirectory("Public\\Html");
771771
<param name="searchOption">One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories.
772772

773773
The default value is <see cref="F:System.IO.SearchOption.TopDirectoryOnly" />.</param>
774-
<summary>Returns an enumerable collection of directory names that match a search pattern in a specified path, and optionally searches subdirectories.</summary>
774+
<summary>Returns an enumerable collection of directory full names that match a search pattern in a specified path, and optionally searches subdirectories.</summary>
775775
<returns>An enumerable collection of the full names (including paths) for the directories in the directory specified by <paramref name="path" /> and that match the specified search pattern and option.</returns>
776776
<remarks>
777777
<format type="text/markdown"><![CDATA[
@@ -834,7 +834,7 @@ Directory::CreateDirectory("Public\\Html");
834834
<AssemblyVersion>4.1.0.0</AssemblyVersion>
835835
</AssemblyInfo>
836836
<Docs>
837-
<summary>Returns an enumerable collection of file names that meet specified criteria.</summary>
837+
<summary>Returns an enumerable collection of full file names that meet specified criteria.</summary>
838838
</Docs>
839839
</MemberGroup>
840840
<Member MemberName="EnumerateFiles">
@@ -870,7 +870,7 @@ Directory::CreateDirectory("Public\\Html");
870870
</Parameters>
871871
<Docs>
872872
<param name="path">The relative or absolute path to the directory to search. This string is not case-sensitive.</param>
873-
<summary>Returns an enumerable collection of file names in a specified path.</summary>
873+
<summary>Returns an enumerable collection of full file names in a specified path.</summary>
874874
<returns>An enumerable collection of the full names (including paths) for the files in the directory specified by <paramref name="path" />.</returns>
875875
<remarks>
876876
<format type="text/markdown"><![CDATA[
@@ -945,7 +945,7 @@ Directory::CreateDirectory("Public\\Html");
945945
<Docs>
946946
<param name="path">The relative or absolute path to the directory to search. This string is not case-sensitive.</param>
947947
<param name="searchPattern">The search string to match against the names of files in <paramref name="path" />. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.</param>
948-
<summary>Returns an enumerable collection of file names that match a search pattern in a specified path.</summary>
948+
<summary>Returns an enumerable collection of full file names that match a search pattern in a specified path.</summary>
949949
<returns>An enumerable collection of the full names (including paths) for the files in the directory specified by <paramref name="path" /> and that match the specified search pattern.</returns>
950950
<remarks>
951951
<format type="text/markdown"><![CDATA[
@@ -1085,7 +1085,7 @@ Directory::CreateDirectory("Public\\Html");
10851085
<param name="searchOption">One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories.
10861086

10871087
The default value is <see cref="F:System.IO.SearchOption.TopDirectoryOnly" />.</param>
1088-
<summary>Returns an enumerable collection of file names that match a search pattern in a specified path, and optionally searches subdirectories.</summary>
1088+
<summary>Returns an enumerable collection of full file names that match a search pattern in a specified path, and optionally searches subdirectories.</summary>
10891089
<returns>An enumerable collection of the full names (including paths) for the files in the directory specified by <paramref name="path" /> and that match the specified search pattern and option.</returns>
10901090
<remarks>
10911091
<format type="text/markdown"><![CDATA[

0 commit comments

Comments
 (0)