Skip to content

Automatically port System.IO triple slash comments #2675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jul 31, 2019
Merged

Automatically port System.IO triple slash comments #2675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
00345bd
Automatically port System.IO triple slash comments
carlossanlop Jul 1, 2019
f72aaaf
suggestions by mairaw
carlossanlop Jul 3, 2019
0f42371
Suggestions by JeremyKuhne and mairaw
carlossanlop Jul 9, 2019
404bea4
Remark for Reset
carlossanlop Jul 9, 2019
bafd028
remarks
carlossanlop Jul 19, 2019
751b0b9
Update FileSystemEntry.xml
mairaw Jul 24, 2019
a576c35
broken link
carlossanlop Jul 24, 2019
0d9b05d
Update FileSystemEnumerable`1+FindTransform.xml
mairaw Jul 24, 2019
436d42d
Update FileSystemEnumerator`1.xml
mairaw Jul 24, 2019
33f4a96
Update FileSystemName.xml
mairaw Jul 24, 2019
2006aa1
Update PackUriHelper.xml
mairaw Jul 24, 2019
f04763e
Update EnumerationOptions.xml
mairaw Jul 24, 2019
be4b10d
Update MatchCasing.xml
mairaw Jul 24, 2019
7bb993f
Update MatchType.xml
mairaw Jul 24, 2019
00adf63
Fixed broken crefs
Jul 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions xml/System.IO.Enumeration/FileSystemEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides a lower level view of <see cref="T:System.IO.FileSystemInfo" /> to help process and filter find results.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -47,8 +47,8 @@
<ReturnType>System.IO.FileAttributes</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the attributes for this entry.</summary>
<value>The attributes for this entry.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -72,8 +72,8 @@
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<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>
<value>The creation time for the entry.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -97,8 +97,8 @@
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the full path of the directory this entry resides in.</summary>
<value>The full path of this entry's directory.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -122,8 +122,8 @@
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the file name for this entry.</summary>
<value>This entry's file name.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -147,8 +147,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether this entry is a directory.</summary>
<value><see langword="true" /> if the entry is a directory; otherwise, <see langword="true" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -172,8 +172,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether the file has the hidden attribute.</summary>
<value><see langword="true" /> if the file has the hidden attribute; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -197,8 +197,8 @@
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a datetime offset that represents the last access time in UTC.</summary>
<value>The last access time in UTC.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -222,8 +222,8 @@
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a datetime offset that represents the last write time in UTC.</summary>
<value>The last write time in UTC.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -247,8 +247,8 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the length of the file, in bytes.</summary>
<value>The file length in bytes.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -272,8 +272,8 @@
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the root directory for the enumeration as specified in the constructor.</summary>
<value>The original root directory.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -297,8 +297,8 @@
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the full path of the root directory used for the enumeration.</summary>
<value>The root directory.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -323,8 +323,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Converts the value of this instance to a <see cref="T:System.IO.FileSystemInfo" />.</summary>
<returns>The value of this instance as a <see cref="T:System.IO.FileSystemInfo" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -349,8 +349,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns the full path of the find result.</summary>
<returns>A string representing the full path.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -375,10 +375,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns the full path for the find results, based on the initially provided path.</summary>
<returns>A string representing the full path.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
8 changes: 4 additions & 4 deletions xml/System.IO.Enumeration/FileSystemEnumerable`1+FindPredicate.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<param name="entry">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="entry">A reference to the file system entry that will be evaluated with the predicate condition.</param>
<summary>Encapsulates a method for filtering out find results.</summary>
<returns><see langword="true" /> if the predicate condition is met; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Type>
</Type>
8 changes: 4 additions & 4 deletions xml/System.IO.Enumeration/FileSystemEnumerable`1+FindTransform.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
<ReturnType>TResult</ReturnType>
</ReturnValue>
<Docs>
<param name="entry">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="entry">A reference to the file system entry that will be evaluated with the predicate condition.</param>
<summary>Encapsulates a method for transforming raw find data into a result.</summary>
<returns>An instance of the type that this delegate encapsulates.</returns>
<remarks>To be added.</remarks>
</Docs>
</Type>
</Type>
22 changes: 11 additions & 11 deletions xml/System.IO.Enumeration/FileSystemEnumerable`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
</Interface>
</Interfaces>
<Docs>
<typeparam name="TResult">To be added.</typeparam>
<summary>To be added.</summary>
<typeparam name="TResult">The type that this enumerable encapsulates.</typeparam>
<summary>Allows utilizing custom filter predicates and transform delegates for enumeration purposes.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -85,8 +85,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Retrieves the enumerator for this type of result.</summary>
<returns>An enumerator.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -110,8 +110,8 @@
<ReturnType>System.IO.Enumeration.FileSystemEnumerable&lt;TResult&gt;+FindPredicate</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the predicate that can be used to verify if the TResults should be included.</summary>
<value>The include predicate.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -135,8 +135,8 @@
<ReturnType>System.IO.Enumeration.FileSystemEnumerable&lt;TResult&gt;+FindPredicate</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the predicate that can be used to verify if the TResults should be recursed.</summary>
<value>The recurse predicate.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -163,10 +163,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Gets an enumerator that can be used to iterate.</summary>
<returns>An enumerator instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
Loading