Skip to content

Commit d0b691f

Browse files
carlossanlopmairaw
carlossanlop
and
mairaw
committed
Automatically port System.Xml.Linq.XElement triple slash (#3098)
* Automatically port System.Xml.Linq.XElement * remove BOM character * suggestions by mairaw Co-Authored-By: Maira Wenzel <[email protected]> * suggestions by mairaw Co-Authored-By: Maira Wenzel <[email protected]>
1 parent b39b2cc commit d0b691f

File tree

1 file changed

+51
-35
lines changed

1 file changed

+51
-35
lines changed

‎xml/System.Xml.Linq/XElement.xml

Lines changed: 51 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3676,12 +3676,20 @@ Root 1 2
36763676
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
36773677
</Parameters>
36783678
<Docs>
3679-
<param name="stream">To be added.</param>
3680-
<param name="options">To be added.</param>
3681-
<param name="cancellationToken">To be added.</param>
3682-
<summary>To be added.</summary>
3683-
<returns>To be added.</returns>
3684-
<remarks>To be added.</remarks>
3679+
<param name="stream">The stream containing the raw XML to read.</param>
3680+
<param name="options">A bitwise combination of the enumeration values that specify the load options to parse the XML.</param>
3681+
<param name="cancellationToken">A token that can be used to request cancellation of the asynchronous operation.</param>
3682+
<summary>Asynchronously creates a new <see cref="T:System.Xml.Linq.XElement" /> and initializes its underlying XML tree using the specified stream, optionally preserving white space.</summary>
3683+
<returns>A new <see cref="T:System.Xml.Linq.XElement" /> containing the contents of the specified stream.</returns>
3684+
<remarks>
3685+
<format type="text/markdown"><![CDATA[
3686+
3687+
## Remarks
3688+
3689+
If `options` is set to <xref:System.Xml.Linq.LoadOptions.PreserveWhitespace>, then the <xref:System.Xml.XmlReaderSettings.IgnoreWhitespace> property is set to `false`.
3690+
3691+
]]></format>
3692+
</remarks>
36853693
</Docs>
36863694
</Member>
36873695
<Member MemberName="LoadAsync">
@@ -3712,12 +3720,20 @@ Root 1 2
37123720
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
37133721
</Parameters>
37143722
<Docs>
3715-
<param name="textReader">To be added.</param>
3716-
<param name="options">To be added.</param>
3717-
<param name="cancellationToken">To be added.</param>
3718-
<summary>To be added.</summary>
3719-
<returns>To be added.</returns>
3720-
<remarks>To be added.</remarks>
3723+
<param name="textReader">A reader containing the raw XML to read.</param>
3724+
<param name="options">A bitwise combination of the enumeration values that specify the load options to parse the XML.</param>
3725+
<param name="cancellationToken">A token that can be used to request cancellation of the asynchronous operation.</param>
3726+
<summary>Asynchronously creates a new <see cref="T:System.Xml.Linq.XElement" /> and initializes its underlying XML tree using the specified text reader, optionally preserving white space.</summary>
3727+
<returns>A new <see cref="T:System.Xml.Linq.XElement" /> containing the contents of the specified reader.</returns>
3728+
<remarks>
3729+
<format type="text/markdown"><![CDATA[
3730+
3731+
## Remarks
3732+
3733+
If `options` is set to <xref:System.Xml.Linq.LoadOptions.PreserveWhitespace>, then the <xref:System.Xml.XmlReaderSettings.IgnoreWhitespace> property is set to `false`.
3734+
3735+
]]></format>
3736+
</remarks>
37213737
</Docs>
37223738
</Member>
37233739
<Member MemberName="LoadAsync">
@@ -3748,11 +3764,11 @@ Root 1 2
37483764
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
37493765
</Parameters>
37503766
<Docs>
3751-
<param name="reader">To be added.</param>
3752-
<param name="options">To be added.</param>
3753-
<param name="cancellationToken">To be added.</param>
3754-
<summary>To be added.</summary>
3755-
<returns>To be added.</returns>
3767+
<param name="reader">A reader containing the XML to be read.</param>
3768+
<param name="options">A bitwise combination of the enumeration values that specify the load options to parse the XML.</param>
3769+
<param name="cancellationToken">A token that can be used to request cancellation of the asynchronous operation.</param>
3770+
<summary>Asynchronously creates a new <see cref="T:System.Xml.Linq.XElement" /> and initializes its underlying XML tree using the specified XML reader, optionally preserving white space.</summary>
3771+
<returns>A new <see cref="T:System.Xml.Linq.XElement" /> containing the contents of the specified reader.</returns>
37563772
<remarks>To be added.</remarks>
37573773
</Docs>
37583774
</Member>
@@ -7500,10 +7516,10 @@ Console.WriteLine(str)
75007516
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
75017517
</Parameters>
75027518
<Docs>
7503-
<param name="writer">To be added.</param>
7504-
<param name="cancellationToken">To be added.</param>
7505-
<summary>To be added.</summary>
7506-
<returns>To be added.</returns>
7519+
<param name="writer">The writer to output the XML to.</param>
7520+
<param name="cancellationToken">A token that can be used to request cancellation of the asynchronous operation.</param>
7521+
<summary>Asynchronously outputs this <see cref="T:System.Xml.Linq.XElement" /> to an <see cref="T:System.Xml.XmlWriter" />.</summary>
7522+
<returns>A task representing the asynchronous save operation.</returns>
75077523
<remarks>To be added.</remarks>
75087524
</Docs>
75097525
</Member>
@@ -7535,11 +7551,11 @@ Console.WriteLine(str)
75357551
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
75367552
</Parameters>
75377553
<Docs>
7538-
<param name="stream">To be added.</param>
7539-
<param name="options">To be added.</param>
7540-
<param name="cancellationToken">To be added.</param>
7541-
<summary>To be added.</summary>
7542-
<returns>To be added.</returns>
7554+
<param name="stream">The stream to output the XML to.</param>
7555+
<param name="options">A bitwise combination of the enumeration values that specify the serialization options.</param>
7556+
<param name="cancellationToken">A token that can be used to request cancellation of the asynchronous operation.</param>
7557+
<summary>Asynchronously outputs this <see cref="T:System.Xml.Linq.XElement" /> to a <see cref="T:System.IO.Stream" />.</summary>
7558+
<returns>A task representing the asynchronous save operation.</returns>
75437559
<remarks>To be added.</remarks>
75447560
</Docs>
75457561
</Member>
@@ -7571,11 +7587,11 @@ Console.WriteLine(str)
75717587
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
75727588
</Parameters>
75737589
<Docs>
7574-
<param name="textWriter">To be added.</param>
7575-
<param name="options">To be added.</param>
7576-
<param name="cancellationToken">To be added.</param>
7577-
<summary>To be added.</summary>
7578-
<returns>To be added.</returns>
7590+
<param name="textWriter">The writer to output the XML to.</param>
7591+
<param name="options">A bitwise combination of the enumeration values that specify the serialization options.</param>
7592+
<param name="cancellationToken">A token that can be used to request cancellation of the asynchronous operation.</param>
7593+
<summary>Asynchronously outputs this <see cref="T:System.Xml.Linq.XElement" /> to a <see cref="T:System.IO.TextWriter" />.</summary>
7594+
<returns>A task representing the asynchronous save operation.</returns>
75797595
<remarks>To be added.</remarks>
75807596
</Docs>
75817597
</Member>
@@ -8237,10 +8253,10 @@ Console.WriteLine(sb.ToString())
82378253
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
82388254
</Parameters>
82398255
<Docs>
8240-
<param name="writer">To be added.</param>
8241-
<param name="cancellationToken">To be added.</param>
8242-
<summary>To be added.</summary>
8243-
<returns>To be added.</returns>
8256+
<param name="writer">The writer to write this <see cref="T:System.Xml.Linq.XElement" /> to.</param>
8257+
<param name="cancellationToken">A token that can be used to request cancellation of the asynchronous operation.</param>
8258+
<summary>Asynchronously writes this <see cref="T:System.Xml.Linq.XElement" /> to the specified writer.</summary>
8259+
<returns>A task representing the asynchronous write operation.</returns>
82448260
<remarks>To be added.</remarks>
82458261
</Docs>
82468262
</Member>

0 commit comments

Comments
 (0)