Skip to content

Commit 5e1252c

Browse files
cxwtoolcxwtool
committed
Merge branch 'master' into publish-3250
2 parents 972ed76 + 81dadda commit 5e1252c

File tree

10 files changed

+96
-30
lines changed

10 files changed

+96
-30
lines changed

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="FileSystemEnumerable&lt;TResult&gt;" FullName="System.IO.Enumeration.FileSystemEnumerable&lt;TResult&gt;">
1+
<Type Name="FileSystemEnumerable&lt;TResult&gt;" FullName="System.IO.Enumeration.FileSystemEnumerable&lt;TResult&gt;">
22
<TypeSignature Language="C#" Value="public class FileSystemEnumerable&lt;TResult&gt; : System.Collections.Generic.IEnumerable&lt;TResult&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FileSystemEnumerable`1&lt;TResult&gt; extends System.Object implements class System.Collections.Generic.IEnumerable`1&lt;!TResult&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.IO.Enumeration.FileSystemEnumerable`1" />
@@ -188,7 +188,15 @@
188188
<Docs>
189189
<summary>Gets an enumerator that can be used to iterate.</summary>
190190
<returns>An enumerator instance.</returns>
191-
<remarks>To be added.</remarks>
191+
<remarks>
192+
<format type="text/markdown"><![CDATA[
193+
194+
## Remarks
195+
196+
This member is an explicit interface member implementation. It can be used only when the <xref:System.IO.Enumeration.FileSystemEnumerable`1> instance is cast to an <xref:System.Collections.IEnumerable> interface.
197+
198+
]]></format>
199+
</remarks>
192200
</Docs>
193201
</Member>
194202
</Members>

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="FileSystemEnumerator&lt;TResult&gt;" FullName="System.IO.Enumeration.FileSystemEnumerator&lt;TResult&gt;">
1+
<Type Name="FileSystemEnumerator&lt;TResult&gt;" FullName="System.IO.Enumeration.FileSystemEnumerator&lt;TResult&gt;">
22
<TypeSignature Language="C#" Value="public abstract class FileSystemEnumerator&lt;TResult&gt; : System.Runtime.ConstrainedExecution.CriticalFinalizerObject, System.Collections.Generic.IEnumerator&lt;TResult&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit FileSystemEnumerator`1&lt;TResult&gt; extends System.Runtime.ConstrainedExecution.CriticalFinalizerObject implements class System.Collections.Generic.IEnumerator`1&lt;!TResult&gt;, class System.Collections.IEnumerator, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:System.IO.Enumeration.FileSystemEnumerator`1" />
@@ -383,7 +383,15 @@ As described in the remarks for <xref:System.Collections.IEnumerator>, the `Rese
383383
<Docs>
384384
<summary>Gets the currently visited object.</summary>
385385
<value>The currently visited object.</value>
386-
<remarks>To be added.</remarks>
386+
<remarks>
387+
<format type="text/markdown"><![CDATA[
388+
389+
## Remarks
390+
391+
This member is an explicit interface member implementation. It can be used only when the <xref:System.IO.Enumeration.FileSystemEnumerator`1> instance is cast to an <xref:System.Collections.IEnumerator> interface.
392+
393+
]]></format>
394+
</remarks>
387395
</Docs>
388396
</Member>
389397
<Member MemberName="TransformEntry">

‎xml/System.IO.Log/LogExtentCollection.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="LogExtentCollection" FullName="System.IO.Log.LogExtentCollection">
1+
<Type Name="LogExtentCollection" FullName="System.IO.Log.LogExtentCollection">
22
<TypeSignature Language="C#" Value="public sealed class LogExtentCollection : System.Collections.Generic.IEnumerable&lt;System.IO.Log.LogExtent&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit LogExtentCollection extends System.Object implements class System.Collections.Generic.IEnumerable`1&lt;class System.IO.Log.LogExtent&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.IO.Log.LogExtentCollection" />
@@ -413,7 +413,15 @@
413413
<Docs>
414414
<summary>Gets an enumerator for the <see cref="T:System.IO.Log.LogExtent" /> instances in this collection. This method cannot be inherited.</summary>
415415
<returns>An enumerator for the <see cref="T:System.IO.Log.LogExtent" /> instances in this collection.</returns>
416-
<remarks>To be added.</remarks>
416+
<remarks>
417+
<format type="text/markdown"><![CDATA[
418+
419+
## Remarks
420+
421+
This member is an explicit interface member implementation. It can be used only when the <xref:System.IO.Log.LogExtentCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
422+
423+
]]></format>
424+
</remarks>
417425
</Docs>
418426
</Member>
419427
</Members>

‎xml/System.IO.Log/ReservationCollection.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ReservationCollection" FullName="System.IO.Log.ReservationCollection">
1+
<Type Name="ReservationCollection" FullName="System.IO.Log.ReservationCollection">
22
<TypeSignature Language="C#" Value="public abstract class ReservationCollection : System.Collections.Generic.ICollection&lt;long&gt;, System.Collections.Generic.IEnumerable&lt;long&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ReservationCollection extends System.Object implements class System.Collections.Generic.ICollection`1&lt;int64&gt;, class System.Collections.Generic.IEnumerable`1&lt;int64&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.IO.Log.ReservationCollection" />
@@ -628,7 +628,15 @@ recordSequence.Append(undoRecordData, userSqn, previousSqn, RecordAppendOptions.
628628
<Docs>
629629
<summary>Returns an enumerator that can iterate through the <see cref="T:System.IO.Log.ReservationCollection" />. This method cannot be inherited.</summary>
630630
<returns>An enumerator that can iterate through the <see cref="T:System.IO.Log.ReservationCollection" />.</returns>
631-
<remarks>To be added.</remarks>
631+
<remarks>
632+
<format type="text/markdown"><![CDATA[
633+
634+
## Remarks
635+
636+
This member is an explicit interface member implementation. It can be used only when the <xref:System.IO.Log.ReservationCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
637+
638+
]]></format>
639+
</remarks>
632640
<exception cref="T:System.InvalidOperationException">The operation is invalid for one of the following reasons:
633641

634642
- The enumeration has ended.

‎xml/System.IO.Packaging/Package.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="Package" FullName="System.IO.Packaging.Package">
1+
<Type Name="Package" FullName="System.IO.Packaging.Package">
22
<TypeSignature Language="C#" Value="public abstract class Package : IDisposable" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Package extends System.Object implements class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:System.IO.Packaging.Package" />
@@ -2059,7 +2059,15 @@
20592059
<Parameters />
20602060
<Docs>
20612061
<summary>This member supports the [!INCLUDE[TLA#tla_winclient](~/includes/tlasharptla-winclient-md.md)] infrastructure and is not intended for application use. Use the type-safe <see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)" /> method instead.</summary>
2062-
<remarks>To be added.</remarks>
2062+
<remarks>
2063+
<format type="text/markdown"><![CDATA[
2064+
2065+
## Remarks
2066+
2067+
This member is an explicit interface member implementation. It can be used only when the <xref:System.IO.Packaging.Package> instance is cast to an <xref:System.IDisposable> interface.
2068+
2069+
]]></format>
2070+
</remarks>
20632071
</Docs>
20642072
</Member>
20652073
</Members>

‎xml/System.IO.Packaging/PackageRelationshipCollection.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PackageRelationshipCollection" FullName="System.IO.Packaging.PackageRelationshipCollection">
1+
<Type Name="PackageRelationshipCollection" FullName="System.IO.Packaging.PackageRelationshipCollection">
22
<TypeSignature Language="C#" Value="public class PackageRelationshipCollection : System.Collections.Generic.IEnumerable&lt;System.IO.Packaging.PackageRelationship&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PackageRelationshipCollection extends System.Object implements class System.Collections.Generic.IEnumerable`1&lt;class System.IO.Packaging.PackageRelationship&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.IO.Packaging.PackageRelationshipCollection" />
@@ -146,7 +146,15 @@
146146
<Docs>
147147
<summary>This type or member supports the Windows Presentation Foundation infrastructure and is not intended to be used directly from your code.</summary>
148148
<returns>Do not use - use <see cref="M:System.IO.Packaging.PackageRelationshipCollection.GetEnumerator" />.</returns>
149-
<remarks>To be added.</remarks>
149+
<remarks>
150+
<format type="text/markdown"><![CDATA[
151+
152+
## Remarks
153+
154+
This member is an explicit interface member implementation. It can be used only when the <xref:System.IO.Packaging.PackageRelationshipCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
155+
156+
]]></format>
157+
</remarks>
150158
</Docs>
151159
</Member>
152160
</Members>

‎xml/System.IO/BinaryWriter.xml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="BinaryWriter" FullName="System.IO.BinaryWriter">
1+
<Type Name="BinaryWriter" FullName="System.IO.BinaryWriter">
22
<TypeSignature Language="C#" Value="public class BinaryWriter : IDisposable" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.5;netstandard-1.6;netstandard-2.0;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BinaryWriter extends System.Object implements class System.IDisposable" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.5;netstandard-1.6;netstandard-2.0" />
44
<TypeSignature Language="DocId" Value="T:System.IO.BinaryWriter" />
@@ -891,10 +891,18 @@
891891
<Parameters />
892892
<Docs>
893893
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.BinaryWriter" /> and optionally releases the managed resources.</summary>
894-
<remarks>To be added.</remarks>
895-
<related type="Article" href="/dotnet/standard/io/">File and Stream I/O</related>
896-
<related type="Article" href="/dotnet/standard/io/how-to-read-text-from-a-file">How to: Read Text from a File</related>
897-
<related type="Article" href="/dotnet/standard/io/how-to-write-text-to-a-file">How to: Write Text to a File</related>
894+
<remarks>
895+
<format type="text/markdown"><![CDATA[
896+
897+
## Remarks
898+
899+
This member is an explicit interface member implementation. It can be used only when the <xref:System.IO.BinaryWriter> instance is cast to an <xref:System.IDisposable> interface.
900+
901+
]]></format>
902+
</remarks>
903+
<related type="Article" href="~/docs/standard/io/index.md">File and Stream I/O</related>
904+
<related type="Article" href="~/docs/standard/io/how-to-read-text-from-a-file.md">How to: Read Text from a File</related>
905+
<related type="Article" href="~/docs/standard/io/how-to-write-text-to-a-file.md">How to: Write Text to a File</related>
898906
</Docs>
899907
</Member>
900908
<MemberGroup MemberName="Write">

‎xml/System.IO/FileSystemAclExtensions.xml

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="FileSystemAclExtensions" FullName="System.IO.FileSystemAclExtensions">
1+
<Type Name="FileSystemAclExtensions" FullName="System.IO.FileSystemAclExtensions">
22
<TypeSignature Language="C#" Value="public static class FileSystemAclExtensions" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit FileSystemAclExtensions extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.IO.FileSystemAclExtensions" />
@@ -210,11 +210,21 @@ namespace ConsoleApp
210210
<Parameter Name="path" Type="System.String" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0;net-5.0" />
211211
</Parameters>
212212
<Docs>
213-
<param name="directorySecurity">To be added.</param>
214-
<param name="path">To be added.</param>
215-
<summary>To be added.</summary>
216-
<returns>To be added.</returns>
217-
<remarks>To be added.</remarks>
213+
<param name="directorySecurity">An object that determines the access control and audit security for the directory.</param>
214+
<param name="path">The path of the directory to create.</param>
215+
<summary>Creates a directory and returns it, ensuring it is created with the specified directory security. If the directory already exists, the existing directory is returned.</summary>
216+
<returns>A directory information object representing either a created directory with the provided security properties, or the existing directory.</returns>
217+
<remarks>
218+
<format type="text/markdown"><![CDATA[
219+
220+
## Remarks
221+
222+
This extension method was added to .NET Core to bring the functionality that was provided by the `System.IO.Directory.CreateDirectory(System.String,System.Security.AccessControl.DirectorySecurity)` .NET Framework method.
223+
224+
]]></format>
225+
</remarks>
226+
<exception cref="T:System.ArgumentNullException"><paramref name="directorySecurity" /> or <paramref name="path" /> is <see langword="null" />.</exception>
227+
<exception cref="T:System.ArgumentException"><paramref name="path" /> is empty.</exception>
218228
</Docs>
219229
</Member>
220230
<Member MemberName="GetAccessControl">

‎xml/System.IO/UnmanagedMemoryStream.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="UnmanagedMemoryStream" FullName="System.IO.UnmanagedMemoryStream">
1+
<Type Name="UnmanagedMemoryStream" FullName="System.IO.UnmanagedMemoryStream">
22
<TypeSignature Language="C#" Value="public class UnmanagedMemoryStream : System.IO.Stream" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UnmanagedMemoryStream extends System.IO.Stream" />
44
<TypeSignature Language="DocId" Value="T:System.IO.UnmanagedMemoryStream" />
@@ -646,10 +646,10 @@
646646
<Parameter Name="bufferSize" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
647647
</Parameters>
648648
<Docs>
649-
<param name="callback">To be added.</param>
650-
<param name="state">To be added.</param>
651-
<param name="bufferSize">To be added.</param>
652-
<summary>To be added.</summary>
649+
<param name="callback">The callback tho handle the stream contents to be copied.</param>
650+
<param name="state">A user-defined state, passed to the callback.</param>
651+
<param name="bufferSize">The buffer size of the span.</param>
652+
<summary>Copies the current unmanaged memory stream instance contents and sends them to the specified callback for processing.</summary>
653653
<remarks>To be added.</remarks>
654654
</Docs>
655655
</Member>

‎xml/System/Environment+SpecialFolder.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@
465465
<Docs>
466466
<summary>The directory for components that are shared across applications.
467467

468-
To get the x86 common program files directory on a non-x86 system, use the <see cref="F:System.Environment.SpecialFolder.ProgramFilesX86" /> member.</summary>
468+
To get the x86 common program files directory in a non-x86 process, use the <see cref="F:System.Environment.SpecialFolder.ProgramFilesX86" /> member.</summary>
469469
</Docs>
470470
</Member>
471471
<Member MemberName="CommonProgramFilesX86">
@@ -1356,7 +1356,7 @@
13561356
<Docs>
13571357
<summary>The program files directory.
13581358

1359-
On a non-x86 system, passing <see cref="F:System.Environment.SpecialFolder.ProgramFiles" /> to the <see cref="M:System.Environment.GetFolderPath(System.Environment.SpecialFolder)" /> method returns the path for non-x86 programs. To get the x86 program files directory on a non-x86 system, use the <see cref="F:System.Environment.SpecialFolder.ProgramFilesX86" /> member.</summary>
1359+
In a non-x86 process, passing <see cref="F:System.Environment.SpecialFolder.ProgramFiles" /> to the <see cref="M:System.Environment.GetFolderPath(System.Environment.SpecialFolder)" /> method returns the path for non-x86 programs. To get the x86 program files directory in a non-x86 process, use the <see cref="F:System.Environment.SpecialFolder.ProgramFilesX86" /> member.</summary>
13601360
</Docs>
13611361
</Member>
13621362
<Member MemberName="ProgramFilesX86">

0 commit comments

Comments
 (0)