From 00345bd7c73aea0d0999e3a1a9c1dedbdbb56b7c Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Mon, 1 Jul 2019 16:16:06 -0700 Subject: [PATCH 01/15] Automatically port System.IO triple slash comments --- xml/System.IO.Enumeration/FileSystemEntry.xml | 54 +++++++++---------- .../FileSystemEnumerable`1+FindPredicate.xml | 4 +- .../FileSystemEnumerable`1+FindTransform.xml | 4 +- .../FileSystemEnumerable`1.xml | 18 +++---- .../FileSystemEnumerator`1.xml | 52 +++++++++--------- xml/System.IO.Enumeration/FileSystemName.xml | 42 +++++++++------ xml/System.IO.Packaging/PackUriHelper.xml | 4 ++ xml/System.IO/EnumerationOptions.xml | 44 +++++++++------ xml/System.IO/MatchCasing.xml | 6 +-- xml/System.IO/MatchType.xml | 4 +- 10 files changed, 130 insertions(+), 102 deletions(-) diff --git a/xml/System.IO.Enumeration/FileSystemEntry.xml b/xml/System.IO.Enumeration/FileSystemEntry.xml index 389935d4f72..5a911d717da 100644 --- a/xml/System.IO.Enumeration/FileSystemEntry.xml +++ b/xml/System.IO.Enumeration/FileSystemEntry.xml @@ -23,7 +23,7 @@ - To be added. + Lower level view of used for processing and filtering find results. To be added. @@ -47,8 +47,8 @@ System.IO.FileAttributes - To be added. - To be added. + The attributes for this entry. + The attributes for this entry. To be added. @@ -72,8 +72,8 @@ System.DateTimeOffset - To be added. - To be added. + The creation time for the entry or the oldest available time stamp if the operating system does not support creation time stamps. + The creation time for the entry. To be added. @@ -97,8 +97,8 @@ System.ReadOnlySpan<System.Char> - To be added. - To be added. + The full path of the directory this entry resides in. + The full path of this entry's directory. To be added. @@ -122,8 +122,8 @@ System.ReadOnlySpan<System.Char> - To be added. - To be added. + The file name for this entry. + This entrie's file name. To be added. @@ -147,8 +147,8 @@ System.Boolean - To be added. - To be added. + Returns if this entry is a directory. + if the entry is a directory. To be added. @@ -172,8 +172,8 @@ System.Boolean - To be added. - To be added. + Returns if the file has the hidden attribute. + if the file has the hidden attribute. To be added. @@ -222,8 +222,8 @@ System.DateTimeOffset - To be added. - To be added. + A datetime offset representing the last write time in UTC. + A datetime offset. To be added. @@ -247,8 +247,8 @@ System.Int64 - To be added. - To be added. + The length of file in bytes. + The file length in bytes. To be added. @@ -272,8 +272,8 @@ System.ReadOnlySpan<System.Char> - To be added. - To be added. + The root directory for the enumeration as specified in the constructor. + The original root directory. To be added. @@ -297,8 +297,8 @@ System.ReadOnlySpan<System.Char> - To be added. - To be added. + The full path of the root directory used for the enumeration. + The root directory. To be added. @@ -323,8 +323,8 @@ - To be added. - To be added. + Returns this entry as represented by a . + This entry as . To be added. @@ -349,8 +349,8 @@ - To be added. - To be added. + Returns the full path of the find result. + A string representing the full path. To be added. @@ -375,8 +375,8 @@ - To be added. - To be added. + Returns the full path for find results, based on the initially provided path. + A string representing the full path. To be added. diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml index 0c8290deb9e..7eaac843ec4 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml @@ -27,8 +27,8 @@ To be added. - To be added. - To be added. + Delegate for filtering out find results. + if the predicate condition is met. To be added. \ No newline at end of file diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml index 814ae93899f..3b86e9b934e 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml @@ -27,8 +27,8 @@ To be added. - To be added. - To be added. + Delegate for transforming raw find data into a result. + A TResult. To be added. \ No newline at end of file diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml index 929e7d974ca..980002331b2 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml @@ -29,7 +29,7 @@ To be added. - To be added. + Enumerable that allows utilizing custom filter predicates and tranform delegates. To be added. @@ -85,8 +85,8 @@ - To be added. - To be added. + Retrieves the enumerator for this type of result. + An enumerator. To be added. @@ -110,8 +110,8 @@ System.IO.Enumeration.FileSystemEnumerable<TResult>+FindPredicate - To be added. - To be added. + A predicate that can be used to verify if the TResults should be included. + The include predicate. To be added. @@ -135,8 +135,8 @@ System.IO.Enumeration.FileSystemEnumerable<TResult>+FindPredicate - To be added. - To be added. + A predicate that can be used to veirfy if the TResults should be recursed. + The recurse predicate. To be added. @@ -163,8 +163,8 @@ - To be added. - To be added. + Gets an enumerator. + An enumerator. To be added. diff --git a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml index 68808f2923b..ebf6f0e8068 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml @@ -56,9 +56,9 @@ - To be added. - To be added. - To be added. + The directory to search in. + Enumeration options to use. + Encapsulates a find operation. To be added. @@ -85,9 +85,9 @@ - To be added. - To be added. - To be added. + The native error code. + Called when a native API returns an error that would normally cause a throw. + to continue, or to throw the default exception for the given error. To be added. @@ -114,8 +114,8 @@ TResult - To be added. - To be added. + Returns the currently visited element. + An object of TResult type. To be added. @@ -143,7 +143,7 @@ - To be added. + Disposes the FileSystemEnumerator. To be added. @@ -170,8 +170,8 @@ - To be added. - To be added. + if called while disposing. if called from finalizer. + Override for any additional cleanup. To be added. @@ -199,8 +199,8 @@ - To be added. - To be added. + Moves the iterator to the next object. + if it was possible to move to the next object, if it was not possible. To be added. @@ -227,8 +227,8 @@ - To be added. - To be added. + The path of the directory that finished. + Called whenever the end of a directory is reached. To be added. @@ -256,7 +256,7 @@ - To be added. + Resets the enumerator to the initial position. To be added. @@ -283,9 +283,9 @@ - To be added. - To be added. - To be added. + A file system entry reference. + Allows indicating if a file system entry should be included in the results or not. + if the given file system entry should be included in the results, otherwise. To be added. @@ -312,9 +312,9 @@ - To be added. - To be added. - To be added. + A file system entry reference. + Allows indicating if a file system entry should be recursed or not. + if the directory entry given should be recursed into, otherwise. To be added. @@ -341,8 +341,8 @@ System.Object - To be added. - To be added. + Gets the currently visited object. + The currently visited object. To be added. @@ -370,8 +370,8 @@ To be added. - To be added. - To be added. + Generate the result type from the current entry. + A TResult representing the object. To be added. diff --git a/xml/System.IO.Enumeration/FileSystemName.xml b/xml/System.IO.Enumeration/FileSystemName.xml index 4507e4e3b9e..7d144520481 100644 --- a/xml/System.IO.Enumeration/FileSystemName.xml +++ b/xml/System.IO.Enumeration/FileSystemName.xml @@ -18,7 +18,7 @@ - To be added. + Provides methods for matching file system names. To be added. @@ -46,11 +46,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The expression to match with. + The name to check against the expression. + to ignore case (default), if the match should be case-sensitive. + Verifies if the given expression matches the given name. Supports the following wildcards: '*' and '?'. The backslash character '\' escapes. + if the given expression matches the given name, otherwise. To be added. @@ -78,12 +78,17 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The expression to match with, such as "*.foo". + The name to check against the expression. + to ignore case (default), if the match should be case-sensitive. + Verifies if the given Win32 expression matches the given name. Supports the following wildcards: '*', '?', '<', '>', '"'. The backslash character '\' escapes. + if the given expression matches the given name, otherwise. + + . + ]]> + @@ -109,10 +114,15 @@ - To be added. - To be added. - To be added. - To be added. + The expression to translate. + Translates the given Win32 expression. Change '*' and '?' to '<', '>' and '"' to match Win32 behavior. + A string with the translated Win32 expression. + + + + diff --git a/xml/System.IO.Packaging/PackUriHelper.xml b/xml/System.IO.Packaging/PackUriHelper.xml index 097a6d53b6c..c63df3886af 100644 --- a/xml/System.IO.Packaging/PackUriHelper.xml +++ b/xml/System.IO.Packaging/PackUriHelper.xml @@ -635,6 +635,10 @@ Open Packaging Conventions Specification + If the is . + If the is not an absolute . + If the does not have the "pack://" scheme. + If the partUri extracted from does not conform to the valid partUri syntax. diff --git a/xml/System.IO/EnumerationOptions.xml b/xml/System.IO/EnumerationOptions.xml index b49eeec173f..053707d6f8c 100644 --- a/xml/System.IO/EnumerationOptions.xml +++ b/xml/System.IO/EnumerationOptions.xml @@ -39,7 +39,7 @@ - To be added. + Default constructor. Constructs the options class with recommended default options. To be added. @@ -63,8 +63,8 @@ System.IO.FileAttributes - To be added. - To be added. + Skip entries with the given attributes. Default is FileAttributes.Hidden | FileAttributes.System. + The attributes to skip. To be added. @@ -88,9 +88,15 @@ System.Int32 - To be added. - To be added. - To be added. + Suggested buffer size, in bytes. Default is 0 (no suggestion). + The buffer size. + + + @@ -113,7 +119,7 @@ System.Boolean - To be added. + Skip files/directories when access is denied (e.g. /). Default is . To be added. To be added. @@ -138,9 +144,13 @@ System.IO.MatchCasing - To be added. + For APIs that allow specifying a match expression this will allow you to specify case matching behavior. To be added. - To be added. + + + @@ -163,9 +173,13 @@ System.IO.MatchType - To be added. + For APIs that allow specifying a match expression this will allow you to specify how to interpret the match expression. To be added. - To be added. + + + @@ -188,8 +202,8 @@ System.Boolean - To be added. - To be added. + Indicates if we should recurse into subdirectories while enumerating. Default is . + Boolean indicating if we should recurse into subdirectories while enumerating or not. To be added. @@ -213,8 +227,8 @@ System.Boolean - To be added. - To be added. + Set to to return "." and ".." directory entries. + if we will return the special directory entries "." and "..". To be added. diff --git a/xml/System.IO/MatchCasing.xml b/xml/System.IO/MatchCasing.xml index 37eca49f4f7..ae395ef98dd 100644 --- a/xml/System.IO/MatchCasing.xml +++ b/xml/System.IO/MatchCasing.xml @@ -42,7 +42,7 @@ 2 - To be added. + Match ignoring character casing. @@ -66,7 +66,7 @@ 1 - To be added. + Match respecting character casing. @@ -90,7 +90,7 @@ 0 - To be added. + Match the default casing for the given platform. diff --git a/xml/System.IO/MatchType.xml b/xml/System.IO/MatchType.xml index 47a6c597b6c..84abcebfb6c 100644 --- a/xml/System.IO/MatchType.xml +++ b/xml/System.IO/MatchType.xml @@ -42,7 +42,7 @@ 0 - To be added. + Match using '*' and '?' wildcards. @@ -66,7 +66,7 @@ 1 - To be added. + Match using Win32 DOS style matching semantics. '*', '?', '<', '>', and '"' are all considered wildcards. From f72aaaf010321888131e34d40a9fe4b74e0bb517 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 3 Jul 2019 14:22:47 -0700 Subject: [PATCH 02/15] suggestions by mairaw Co-Authored-By: Maira Wenzel --- xml/System.IO.Enumeration/FileSystemEntry.xml | 30 ++++++++-------- .../FileSystemEnumerable`1+FindPredicate.xml | 4 +-- .../FileSystemEnumerable`1.xml | 6 ++-- .../FileSystemEnumerator`1.xml | 34 +++++++++---------- 4 files changed, 37 insertions(+), 37 deletions(-) diff --git a/xml/System.IO.Enumeration/FileSystemEntry.xml b/xml/System.IO.Enumeration/FileSystemEntry.xml index 5a911d717da..3a035b0306f 100644 --- a/xml/System.IO.Enumeration/FileSystemEntry.xml +++ b/xml/System.IO.Enumeration/FileSystemEntry.xml @@ -47,7 +47,7 @@ System.IO.FileAttributes - The attributes for this entry. + Gets the attributes for this entry. The attributes for this entry. To be added. @@ -72,7 +72,7 @@ System.DateTimeOffset - The creation time for the entry or the oldest available time stamp if the operating system does not support creation time stamps. + Gets the creation time for the entry or the oldest available time stamp if the operating system does not support creation time stamps. The creation time for the entry. To be added. @@ -97,7 +97,7 @@ System.ReadOnlySpan<System.Char> - The full path of the directory this entry resides in. + Gets the full path of the directory this entry resides in. The full path of this entry's directory. To be added. @@ -122,8 +122,8 @@ System.ReadOnlySpan<System.Char> - The file name for this entry. - This entrie's file name. + Gets the file name for this entry. + This entry's file name. To be added. @@ -147,8 +147,8 @@ System.Boolean - Returns if this entry is a directory. - if the entry is a directory. + Gets a value that indicates whether this entry is a directory. + if the entry is a directory; otherwise, . To be added. @@ -172,8 +172,8 @@ System.Boolean - Returns if the file has the hidden attribute. - if the file has the hidden attribute. + Gets a value that indicates whether the file has the hidden attribute. + if the file has the hidden attribute; otherwise, . To be added. @@ -222,7 +222,7 @@ System.DateTimeOffset - A datetime offset representing the last write time in UTC. + Gets a datetime offset that represents the last write time in UTC. A datetime offset. To be added. @@ -247,7 +247,7 @@ System.Int64 - The length of file in bytes. + Gets the length of the file, in bytes. The file length in bytes. To be added. @@ -272,7 +272,7 @@ System.ReadOnlySpan<System.Char> - The root directory for the enumeration as specified in the constructor. + Gets the root directory for the enumeration as specified in the constructor. The original root directory. To be added. @@ -297,7 +297,7 @@ System.ReadOnlySpan<System.Char> - The full path of the root directory used for the enumeration. + Gets the full path of the root directory used for the enumeration. The root directory. To be added. @@ -375,10 +375,10 @@ - Returns the full path for find results, based on the initially provided path. + Returns the full path for the find results, based on the initially provided path. A string representing the full path. To be added. - \ No newline at end of file + diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml index 7eaac843ec4..55fa71c2d5b 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml @@ -28,7 +28,7 @@ To be added. Delegate for filtering out find results. - if the predicate condition is met. + if the predicate condition is met; otherwise, . To be added. - \ No newline at end of file + diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml index 980002331b2..b50106b5977 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml @@ -110,7 +110,7 @@ System.IO.Enumeration.FileSystemEnumerable<TResult>+FindPredicate - A predicate that can be used to verify if the TResults should be included. + Gets or sets the predicate that can be used to verify if the TResults should be included. The include predicate. To be added. @@ -135,7 +135,7 @@ System.IO.Enumeration.FileSystemEnumerable<TResult>+FindPredicate - A predicate that can be used to veirfy if the TResults should be recursed. + Gets or sets the predicate that can be used to verify if the TResults should be recursed. The recurse predicate. To be added. @@ -169,4 +169,4 @@ - \ No newline at end of file + diff --git a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml index ebf6f0e8068..7967cedc49f 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml @@ -87,7 +87,7 @@ The native error code. Called when a native API returns an error that would normally cause a throw. - to continue, or to throw the default exception for the given error. + to continue; to throw the default exception for the given error. To be added. @@ -114,8 +114,8 @@ TResult - Returns the currently visited element. - An object of TResult type. + Gets the currently visited element. + The currently visited element. To be added. @@ -143,7 +143,7 @@ - Disposes the FileSystemEnumerator. + Releases the resources used by the current instance of the class. To be added. @@ -170,8 +170,8 @@ - if called while disposing. if called from finalizer. - Override for any additional cleanup. + to release both managed and unmanaged resources; to release only unmanaged resources. + When overridden in a derived class, releases the unmanaged resources used by the class and optionally releases the managed resources. To be added. @@ -199,8 +199,8 @@ - Moves the iterator to the next object. - if it was possible to move to the next object, if it was not possible. + Advances the enumerator to the next item of the . + if the enumerator successfully advanced to the next item; if the end of the enumerator has been passed. To be added. @@ -227,7 +227,7 @@ - The path of the directory that finished. + The path of the directory. Called whenever the end of a directory is reached. To be added. @@ -256,7 +256,7 @@ - Resets the enumerator to the initial position. + Always throws . To be added. @@ -284,8 +284,8 @@ A file system entry reference. - Allows indicating if a file system entry should be included in the results or not. - if the given file system entry should be included in the results, otherwise. + When overridden in a derived class, determines whether the specified file system entry should be included in the results. + if the specified file system entry should be included in the results; otherwise, . To be added. @@ -313,8 +313,8 @@ A file system entry reference. - Allows indicating if a file system entry should be recursed or not. - if the directory entry given should be recursed into, otherwise. + When overridden in a derived class, determines whether the specified file system entry should be recursed. + if the specified directory entry should be recursed into; otherwise, . To be added. @@ -370,10 +370,10 @@ To be added. - Generate the result type from the current entry. - A TResult representing the object. + When overridden in a derived class, generates the result type from the current entry. + The result type from the current entry. To be added. - \ No newline at end of file + From 0f42371f3f706ba7bb0d1d4f15c82482c6f93918 Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Tue, 9 Jul 2019 16:20:56 -0700 Subject: [PATCH 03/15] Suggestions by JeremyKuhne and mairaw --- xml/System.IO.Enumeration/FileSystemEntry.xml | 6 ++--- .../FileSystemEnumerable`1+FindPredicate.xml | 4 ++-- .../FileSystemEnumerable`1+FindTransform.xml | 6 ++--- .../FileSystemEnumerable`1.xml | 8 +++---- .../FileSystemEnumerator`1.xml | 18 +++++++++++---- xml/System.IO.Enumeration/FileSystemName.xml | 7 +----- xml/System.IO/MatchType.xml | 22 +++++++++++++++++++ 7 files changed, 49 insertions(+), 22 deletions(-) diff --git a/xml/System.IO.Enumeration/FileSystemEntry.xml b/xml/System.IO.Enumeration/FileSystemEntry.xml index 3a035b0306f..d8626045da4 100644 --- a/xml/System.IO.Enumeration/FileSystemEntry.xml +++ b/xml/System.IO.Enumeration/FileSystemEntry.xml @@ -23,7 +23,7 @@ - Lower level view of used for processing and filtering find results. + Provides a lower level view of to help process and filter find results. To be added. @@ -323,8 +323,8 @@ - Returns this entry as represented by a . - This entry as . + Converts the value of this instance to a . + The value of this instance as a . To be added. diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml index 55fa71c2d5b..acd9a3aa3bb 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml @@ -26,8 +26,8 @@ System.Boolean - To be added. - Delegate for filtering out find results. + A reference to the file system entry that will be evaluated with the predicate condition. + Encapsulates a method for filtering out find results. if the predicate condition is met; otherwise, . To be added. diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml index 3b86e9b934e..c164be7963f 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml @@ -26,9 +26,9 @@ TResult - To be added. - Delegate for transforming raw find data into a result. - A TResult. + A reference to the file system entry that will be evaluated with the predicate condition. + Encapsulates a method for transforming raw find data into a result. + A instance of the type that this delegate encapsulates. To be added. \ No newline at end of file diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml index b50106b5977..bec6125a8f6 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1.xml @@ -28,8 +28,8 @@ - To be added. - Enumerable that allows utilizing custom filter predicates and tranform delegates. + The type that this enumerable encapsulates. + Allows utilizing custom filter predicates and transform delegates for enumeration purposes. To be added. @@ -163,8 +163,8 @@ - Gets an enumerator. - An enumerator. + Gets an enumerator that can be used to iterate. + An enumerator instance. To be added. diff --git a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml index 7967cedc49f..f46aac79838 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml @@ -86,7 +86,7 @@ The native error code. - Called when a native API returns an error that would normally cause a throw. + When overriden in a derived class, returns a value that indicates whether to continue execution or throw the default exception. to continue; to throw the default exception for the given error. To be added. @@ -227,8 +227,8 @@ - The path of the directory. - Called whenever the end of a directory is reached. + The directory path as a read-only span. + When overriden in a derived class, this method is called whenever the end of a directory is reached. To be added. @@ -257,7 +257,17 @@ Always throws . - To be added. + + + + + diff --git a/xml/System.IO.Enumeration/FileSystemName.xml b/xml/System.IO.Enumeration/FileSystemName.xml index 7d144520481..e6a45521ef9 100644 --- a/xml/System.IO.Enumeration/FileSystemName.xml +++ b/xml/System.IO.Enumeration/FileSystemName.xml @@ -83,12 +83,7 @@ to ignore case (default), if the match should be case-sensitive. Verifies if the given Win32 expression matches the given name. Supports the following wildcards: '*', '?', '<', '>', '"'. The backslash character '\' escapes. if the given expression matches the given name, otherwise. - - . - ]]> - + To be added. diff --git a/xml/System.IO/MatchType.xml b/xml/System.IO/MatchType.xml index 84abcebfb6c..5089f5816ad 100644 --- a/xml/System.IO/MatchType.xml +++ b/xml/System.IO/MatchType.xml @@ -43,6 +43,17 @@ 0 Match using '*' and '?' wildcards. + + + + + @@ -67,6 +78,17 @@ 1 Match using Win32 DOS style matching semantics. '*', '?', '<', '>', and '"' are all considered wildcards. + + + + + From 404bea4ebe6c273168595b3934c0dced9e0911d2 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 9 Jul 2019 16:31:44 -0700 Subject: [PATCH 04/15] Remark for Reset --- xml/System.IO.Enumeration/FileSystemEnumerator`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml index f46aac79838..e2ed4591db7 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml @@ -263,7 +263,7 @@ ## Remarks -Not supported. +As described in the remarks for , the `Reset` method is provided for COM interoperability and does not need to be fully implemented; instead, the implementer can throw a . ]]> From bafd028fde3a105b9a2e76d334886e65ceb50f09 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:30:48 -0700 Subject: [PATCH 05/15] remarks --- xml/System.IO.Enumeration/FileSystemName.xml | 6 +++++- xml/System.IO/EnumerationOptions.xml | 13 ++++++++++++- xml/System.IO/MatchType.xml | 4 ++-- 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/xml/System.IO.Enumeration/FileSystemName.xml b/xml/System.IO.Enumeration/FileSystemName.xml index e6a45521ef9..31927b0d567 100644 --- a/xml/System.IO.Enumeration/FileSystemName.xml +++ b/xml/System.IO.Enumeration/FileSystemName.xml @@ -115,10 +115,14 @@ - \ No newline at end of file + diff --git a/xml/System.IO/EnumerationOptions.xml b/xml/System.IO/EnumerationOptions.xml index 053707d6f8c..d776ce7f90d 100644 --- a/xml/System.IO/EnumerationOptions.xml +++ b/xml/System.IO/EnumerationOptions.xml @@ -92,6 +92,9 @@ The buffer size. To be added. @@ -177,7 +184,11 @@ Default is to match platform defaults, which are gleaned from the case sensitivi To be added. @@ -233,4 +244,4 @@ The default is simple matching where '*' is always 0 or more characters and '?' - \ No newline at end of file + diff --git a/xml/System.IO/MatchType.xml b/xml/System.IO/MatchType.xml index 5089f5816ad..bc5dfa366ea 100644 --- a/xml/System.IO/MatchType.xml +++ b/xml/System.IO/MatchType.xml @@ -84,7 +84,7 @@ ## Remarks -Matches in a traditional DOS / Windows command prompt way. `*.*` matches all files. `?` matches collapse to periods. `file.??t` will match `file.t`, `file.at`, and `file.txt`. +Matches in a traditional DOS `/` Windows command prompt way. `*.*` matches all files. `?` matches collapse to periods. `file.??t` will match `file.t`, `file.at`, and `file.txt`. ]]> @@ -92,4 +92,4 @@ Matches in a traditional DOS / Windows command prompt way. `*.*` matches all fil - \ No newline at end of file + From 751b0b9082fe43315c0a62b7fc167afd195804f0 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Jul 2019 21:24:06 -0700 Subject: [PATCH 06/15] Update FileSystemEntry.xml --- xml/System.IO.Enumeration/FileSystemEntry.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/xml/System.IO.Enumeration/FileSystemEntry.xml b/xml/System.IO.Enumeration/FileSystemEntry.xml index d8626045da4..01bfcdcc1e5 100644 --- a/xml/System.IO.Enumeration/FileSystemEntry.xml +++ b/xml/System.IO.Enumeration/FileSystemEntry.xml @@ -197,8 +197,8 @@ System.DateTimeOffset - To be added. - To be added. + Gets a datetime offset that represents the last access time in UTC. + The last access time in UTC. To be added. @@ -223,7 +223,7 @@ Gets a datetime offset that represents the last write time in UTC. - A datetime offset. + The last write time in UTC. To be added. @@ -323,8 +323,8 @@ - Converts the value of this instance to a . - The value of this instance as a . + Converts the value of this instance to a . + The value of this instance as a . To be added. From a576c3544b762e129c0abc816f35e88e2f43dfa0 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 23 Jul 2019 21:30:23 -0700 Subject: [PATCH 07/15] broken link --- xml/System.IO.Enumeration/FileSystemEntry.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.IO.Enumeration/FileSystemEntry.xml b/xml/System.IO.Enumeration/FileSystemEntry.xml index 01bfcdcc1e5..42033a4b725 100644 --- a/xml/System.IO.Enumeration/FileSystemEntry.xml +++ b/xml/System.IO.Enumeration/FileSystemEntry.xml @@ -23,7 +23,7 @@ - Provides a lower level view of to help process and filter find results. + Provides a lower level view of to help process and filter find results. To be added. From 0d9b05d315fa627c2e57c94f4c4a53181728b763 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Jul 2019 21:36:42 -0700 Subject: [PATCH 08/15] Update FileSystemEnumerable`1+FindTransform.xml --- .../FileSystemEnumerable`1+FindTransform.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml index c164be7963f..b2704b06857 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml @@ -28,7 +28,7 @@ A reference to the file system entry that will be evaluated with the predicate condition. Encapsulates a method for transforming raw find data into a result. - A instance of the type that this delegate encapsulates. + An instance of the type that this delegate encapsulates. To be added. - \ No newline at end of file + From 436d42d4f27d678e1a9297485e32bc24d87648d8 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Jul 2019 22:28:08 -0700 Subject: [PATCH 09/15] Update FileSystemEnumerator`1.xml --- xml/System.IO.Enumeration/FileSystemEnumerator`1.xml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml index e2ed4591db7..cfdbecc0283 100644 --- a/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml +++ b/xml/System.IO.Enumeration/FileSystemEnumerator`1.xml @@ -170,7 +170,7 @@ - to release both managed and unmanaged resources; to release only unmanaged resources. + to release both managed and unmanaged resources; to release only unmanaged resources. When overridden in a derived class, releases the unmanaged resources used by the class and optionally releases the managed resources. To be added. @@ -258,15 +258,13 @@ Always throws . - - , the `Reset` method is provided for COM interoperability and does not need to be fully implemented; instead, the implementer can throw a . - ]]> - + ]]> From 33f4a96a8847e7547d6a1fae2598f000897c47fb Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Jul 2019 22:51:24 -0700 Subject: [PATCH 10/15] Update FileSystemName.xml --- xml/System.IO.Enumeration/FileSystemName.xml | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/xml/System.IO.Enumeration/FileSystemName.xml b/xml/System.IO.Enumeration/FileSystemName.xml index 31927b0d567..eb5fb1b9800 100644 --- a/xml/System.IO.Enumeration/FileSystemName.xml +++ b/xml/System.IO.Enumeration/FileSystemName.xml @@ -48,9 +48,9 @@ The expression to match with. The name to check against the expression. - to ignore case (default), if the match should be case-sensitive. + to ignore case (default); if the match should be case-sensitive. Verifies if the given expression matches the given name. Supports the following wildcards: '*' and '?'. The backslash character '\' escapes. - if the given expression matches the given name, otherwise. + if the given expression matches the given name; otherwise, . To be added. @@ -82,7 +82,7 @@ The name to check against the expression. to ignore case (default), if the match should be case-sensitive. Verifies if the given Win32 expression matches the given name. Supports the following wildcards: '*', '?', '<', '>', '"'. The backslash character '\' escapes. - if the given expression matches the given name, otherwise. + if the given expression matches the given name; otherwise, . To be added. @@ -113,14 +113,13 @@ Translates the given Win32 expression. Change '*' and '?' to '<', '>' and '"' to match Win32 behavior. A string with the translated Win32 expression. - - + ]]> From 2006aa16f87610260968c7b1ece9897d3990a8c8 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Jul 2019 22:54:01 -0700 Subject: [PATCH 11/15] Update PackUriHelper.xml --- xml/System.IO.Packaging/PackUriHelper.xml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/xml/System.IO.Packaging/PackUriHelper.xml b/xml/System.IO.Packaging/PackUriHelper.xml index c63df3886af..613901b9d7a 100644 --- a/xml/System.IO.Packaging/PackUriHelper.xml +++ b/xml/System.IO.Packaging/PackUriHelper.xml @@ -636,9 +636,15 @@ Open Packaging Conventions Specification If the is . - If the is not an absolute . - If the does not have the "pack://" scheme. - If the partUri extracted from does not conform to the valid partUri syntax. + If the is not an absolute . + +-or- + + does not have the "pack://" scheme. + +-or- + +The partUri extracted from does not conform to the valid partUri syntax. @@ -965,4 +971,4 @@ This method does not inspect the part contents; it is based solely on the name. - \ No newline at end of file + From f04763ed24495f2ec6ee938a6dcc6f1294bb48b6 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Jul 2019 23:15:56 -0700 Subject: [PATCH 12/15] Update EnumerationOptions.xml --- xml/System.IO/EnumerationOptions.xml | 41 ++++++++++++++++------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/xml/System.IO/EnumerationOptions.xml b/xml/System.IO/EnumerationOptions.xml index d776ce7f90d..70c58894c40 100644 --- a/xml/System.IO/EnumerationOptions.xml +++ b/xml/System.IO/EnumerationOptions.xml @@ -39,7 +39,7 @@ - Default constructor. Constructs the options class with recommended default options. + Initializes a new instance of the class with the recommended default options. To be added. @@ -63,7 +63,7 @@ System.IO.FileAttributes - Skip entries with the given attributes. Default is FileAttributes.Hidden | FileAttributes.System. + Gets or sets the attributes to skip. Default is FileAttributes.Hidden | FileAttributes.System. The attributes to skip. To be added. @@ -88,17 +88,20 @@ System.Int32 - Suggested buffer size, in bytes. Default is 0 (no suggestion). + Gets or sets the suggested buffer size, in bytes. Default is 0 (no suggestion). The buffer size. +The suggested buffer size will not be used if it has no meaning for the native APIs on the current platform or if it would be too small for getting at least a single result. + + ]]> @@ -122,8 +125,8 @@ We will not use the suggested buffer size if it has no meaning for the native AP System.Boolean - Skip files/directories when access is denied (e.g. /). Default is . - To be added. + Gets or sets a value that indicates whether to skip files or directories when access is denied (for example, or ). Default is . + to skip innacessible files or directories; otherwise, . To be added. @@ -147,16 +150,17 @@ We will not use the suggested buffer size if it has no meaning for the native AP System.IO.MatchCasing - For APIs that allow specifying a match expression this will allow you to specify case matching behavior. - To be added. + Gets or sets the case matching behavior. + One of the enumeration values that indicates the case matching behavior. + ]]> @@ -180,16 +184,17 @@ Default is to match platform defaults, which are gleaned from the case sensitivi System.IO.MatchType - For APIs that allow specifying a match expression this will allow you to specify how to interpret the match expression. - To be added. + Gets or sets the match type. + One of the enumeration values that indicates the match type. + ]]> @@ -213,8 +218,8 @@ The default is simple matching where '*' is always 0 or more characters and '?' System.Boolean - Indicates if we should recurse into subdirectories while enumerating. Default is . - Boolean indicating if we should recurse into subdirectories while enumerating or not. + Gets or sets a value that indicates whether to recurse into subdirectories while enumerating. Default is . + to recurse into subdirectories; otherwise, . To be added. @@ -238,8 +243,8 @@ The default is simple matching where '*' is always 0 or more characters and '?' System.Boolean - Set to to return "." and ".." directory entries. - if we will return the special directory entries "." and "..". + Gets or sets a value that indicates whether to return the special directory entries "." and "..". + to return the special directory entries "." and ".."; otherwise, . To be added. From be4b10d5b13a0980c4d3870df48ce803fa72c359 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Jul 2019 23:17:30 -0700 Subject: [PATCH 13/15] Update MatchCasing.xml --- xml/System.IO/MatchCasing.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System.IO/MatchCasing.xml b/xml/System.IO/MatchCasing.xml index ae395ef98dd..f363cc5a373 100644 --- a/xml/System.IO/MatchCasing.xml +++ b/xml/System.IO/MatchCasing.xml @@ -42,7 +42,7 @@ 2 - Match ignoring character casing. + Matches ignoring character casing. @@ -66,7 +66,7 @@ 1 - Match respecting character casing. + Matches respecting character casing. @@ -90,8 +90,8 @@ 0 - Match the default casing for the given platform. + Matches using the default casing for the given platform. - \ No newline at end of file + From 7bb993f8edac315ec65a053d691e6166f2398b6d Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Jul 2019 23:18:52 -0700 Subject: [PATCH 14/15] Update MatchType.xml --- xml/System.IO/MatchType.xml | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/xml/System.IO/MatchType.xml b/xml/System.IO/MatchType.xml index bc5dfa366ea..fab9c95a497 100644 --- a/xml/System.IO/MatchType.xml +++ b/xml/System.IO/MatchType.xml @@ -42,17 +42,15 @@ 0 - Match using '*' and '?' wildcards. + Matches using '*' and '?' wildcards. - - - + ]]> @@ -79,15 +77,13 @@ Match using Win32 DOS style matching semantics. '*', '?', '<', '>', and '"' are all considered wildcards. - - - + ]]> From 00adf63f9fee38f15075b90c6022e967a6b3d2e0 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 30 Jul 2019 08:43:45 -0700 Subject: [PATCH 15/15] Fixed broken crefs --- xml/System.IO/EnumerationOptions.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/xml/System.IO/EnumerationOptions.xml b/xml/System.IO/EnumerationOptions.xml index 70c58894c40..7dc8506d3b6 100644 --- a/xml/System.IO/EnumerationOptions.xml +++ b/xml/System.IO/EnumerationOptions.xml @@ -63,7 +63,7 @@ System.IO.FileAttributes - Gets or sets the attributes to skip. Default is FileAttributes.Hidden | FileAttributes.System. + Gets or sets the attributes to skip. The default is FileAttributes.Hidden | FileAttributes.System. The attributes to skip. To be added. @@ -88,7 +88,7 @@ System.Int32 - Gets or sets the suggested buffer size, in bytes. Default is 0 (no suggestion). + Gets or sets the suggested buffer size, in bytes. The default is 0 (no suggestion). The buffer size. System.Boolean - Gets or sets a value that indicates whether to skip files or directories when access is denied (for example, or ). Default is . + Gets or sets a value that indicates whether to skip files or directories when access is denied (for example, or ). The default is . to skip innacessible files or directories; otherwise, . To be added. @@ -158,7 +158,7 @@ The suggested buffer size will not be used if it has no meaning for the native A ## Remarks For APIs that allow specifying a match expression, this property allows you to specify the case matching behavior. -Default is to match platform defaults, which are gleaned from the case sensitivity of the temporary folder. +The default is to match platform defaults, which are gleaned from the case sensitivity of the temporary folder. ]]> @@ -218,7 +218,7 @@ The default is simple matching where '*' is always 0 or more characters and '?' System.Boolean - Gets or sets a value that indicates whether to recurse into subdirectories while enumerating. Default is . + Gets or sets a value that indicates whether to recurse into subdirectories while enumerating. The default is . to recurse into subdirectories; otherwise, . To be added.