Skip to content

Commit 102e696

Browse files
authored
Update baselines for mdoc 5.8.9 (#7995)
1 parent 0d624cd commit 102e696

File tree

22 files changed

+164
-178
lines changed

22 files changed

+164
-178
lines changed

xml/System.Collections.Immutable/ImmutableArray.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -973,7 +973,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
973973
<TypeParameter Name="T" />
974974
</TypeParameters>
975975
<Parameters>
976-
<Parameter Name="items" Type="System.ReadOnlySpan&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" RefType="this" />
976+
<Parameter Name="items" Type="System.ReadOnlySpan&lt;T&gt;" RefType="this" Index="0" FrameworkAlternate="net-7.0" />
977977
</Parameters>
978978
<Docs>
979979
<typeparam name="T">The type of element in the list.</typeparam>
@@ -1002,7 +1002,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
10021002
<TypeParameter Name="T" />
10031003
</TypeParameters>
10041004
<Parameters>
1005-
<Parameter Name="items" Type="System.Span&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" RefType="this" />
1005+
<Parameter Name="items" Type="System.Span&lt;T&gt;" RefType="this" Index="0" FrameworkAlternate="net-7.0" />
10061006
</Parameters>
10071007
<Docs>
10081008
<typeparam name="T">The type of element in the list.</typeparam>

xml/System.CommandLine.Builder/CommandLineBuilderExtensions.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@
4040
<Parameter Name="order" Type="System.CommandLine.Invocation.MiddlewareOrder" />
4141
</Parameters>
4242
<Docs>
43+
<param name="builder">A command line builder.</param>
4344
<param name="onInvoke">A delegate that will be invoked before a call to a command handler.</param>
4445
<param name="order">A value indicating the order in which the added delegate will be invoked relative to others in the pipeline.</param>
45-
<param name="builder">A command line builder.</param>
4646
<summary>
4747
Adds a middleware delegate to the invocation pipeline called before a command handler is invoked.
4848
</summary>
@@ -225,8 +225,8 @@
225225
<Parameter Name="responseFileHandling" Type="System.CommandLine.Parsing.ResponseFileHandling" />
226226
</Parameters>
227227
<Docs>
228-
<param name="responseFileHandling">Specifies whether or how response files are parsed.</param>
229228
<param name="builder">A command line builder.</param>
229+
<param name="responseFileHandling">Specifies whether or how response files are parsed.</param>
230230
<summary>To be added.</summary>
231231
<returns>The same instance of <see cref="T:System.CommandLine.Builder.CommandLineBuilder" />.</returns>
232232
<remarks>To be added.</remarks>
@@ -570,8 +570,8 @@
570570
<Parameter Name="errorExitCode" Type="System.Nullable&lt;System.Int32&gt;" />
571571
</Parameters>
572572
<Docs>
573-
<param name="errorExitCode">The exit code to use when parser errors occur.</param>
574573
<param name="builder">A command line builder.</param>
574+
<param name="errorExitCode">The exit code to use when parser errors occur.</param>
575575
<summary>
576576
Configures the command line to write error information to standard error when there are errors parsing command line input.
577577
</summary>
@@ -688,8 +688,8 @@
688688
</Parameter>
689689
</Parameters>
690690
<Docs>
691-
<param name="aliases">One or more aliases to use instead of the default to signal that version information should be displayed.</param>
692691
<param name="builder">A command line builder.</param>
692+
<param name="aliases">One or more aliases to use instead of the default to signal that version information should be displayed.</param>
693693
<summary>To be added.</summary>
694694
<returns>To be added.</returns>
695695
<remarks>To be added.</remarks>

xml/System.Data.Common/DbBatch.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial
493493
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
494494
</Parameters>
495495
<Docs>
496-
<param name="behavior">One of the enumeration values that specifies options for batch execution and data retrieval.</param>
496+
<param name="cancellationToken">To be added.</param>
497497
<summary>An asynchronous version of <see cref="Overload:System.Data.Common.DbBatch.ExecuteReader" />, which executes the batch against its connection, returning a <see cref="T:System.Data.Common.DbDataReader" /> which can be used to access the results.</summary>
498498
<returns>A task representing the asynchronous operation.</returns>
499499
<remarks>

xml/System.Data.Common/DbBatchCommandCollection.xml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
<Parameter Name="item" Type="System.Data.Common.DbBatchCommand" />
8080
</Parameters>
8181
<Docs>
82-
<param name="value">The <see cref="P:System.Data.Common.DbBatchCommand" /> to add to the collection.</param>
82+
<param name="item">To be added.</param>
8383
<summary>Adds the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object to the <see cref="T:System.Data.Common.DbBatchCommandCollection" />.</summary>
8484
<remarks>To be added.</remarks>
8585
</Docs>
@@ -132,7 +132,7 @@
132132
<Parameter Name="item" Type="System.Data.Common.DbBatchCommand" />
133133
</Parameters>
134134
<Docs>
135-
<param name="value">The <see cref="P:System.Data.Common.DbBatchCommand" /> to look for in the collection.</param>
135+
<param name="item">To be added.</param>
136136
<summary>Indicates whether a <see cref="T:System.Data.Common.DbBatchCommand" /> is contained in the collection.</summary>
137137
<returns>
138138
<see langword="true" /> if the <see cref="T:System.Data.Common.DbBatchCommand" /> is in the collection; otherwise <see langword="false" />.</returns>
@@ -241,7 +241,6 @@
241241
</ReturnValue>
242242
<Parameters />
243243
<Docs>
244-
<param name="index">The index of the <see cref="T:System.Data.Common.DbBatchCommand" /> in the collection.</param>
245244
<summary>Returns the <see cref="T:System.Data.Common.DbBatchCommand" /> object at the specified index in the collection.</summary>
246245
<returns>The <see cref="T:System.Data.Common.DbBatchCommand" /> object at the specified index in the collection.</returns>
247246
<remarks>To be added.</remarks>
@@ -270,7 +269,7 @@
270269
<Parameter Name="item" Type="System.Data.Common.DbBatchCommand" />
271270
</Parameters>
272271
<Docs>
273-
<param name="value">The <see cref="T:System.Data.Common.DbBatchCommand" /> object in the collection.</param>
272+
<param name="item">To be added.</param>
274273
<summary>Returns the index of the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object.</summary>
275274
<returns>The index of the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object.</returns>
276275
<remarks>To be added.</remarks>
@@ -301,7 +300,7 @@
301300
</Parameters>
302301
<Docs>
303302
<param name="index">The index at which to insert the <see cref="T:System.Data.Common.DbBatchCommand" /> object.</param>
304-
<param name="value">The <see cref="T:System.Data.Common.DbBatchCommand" /> object to insert into the collection.</param>
303+
<param name="item">To be added.</param>
305304
<summary>Inserts the specified index of the <see cref="T:System.Data.Common.DbBatchCommand" /> object with the specified name into the collection at the specified index.</summary>
306305
<remarks>To be added.</remarks>
307306
</Docs>
@@ -385,7 +384,7 @@
385384
<Parameter Name="item" Type="System.Data.Common.DbBatchCommand" />
386385
</Parameters>
387386
<Docs>
388-
<param name="value">The <see cref="T:System.Data.Common.DbBatchCommand" /> object to remove.</param>
387+
<param name="item">To be added.</param>
389388
<summary>Removes the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object from the collection.</summary>
390389
<returns>
391390
<see langword="true" /> if <paramref name="item" /> was successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> was not found in the <see cref="T:System.Data.Common.DbBatchCommandCollection" />.
@@ -443,7 +442,7 @@
443442
</Parameters>
444443
<Docs>
445444
<param name="index">The index where the <see cref="T:System.Data.Common.DbBatchCommand" /> object is located.</param>
446-
<param name="value">The new <see cref="T:System.Data.Common.DbBatchCommand" /> value.</param>
445+
<param name="batchCommand">To be added.</param>
447446
<summary>Sets the <see cref="T:System.Data.Common.DbBatchCommand" /> object at the specified index to a new value.</summary>
448447
<remarks>To be added.</remarks>
449448
</Docs>

xml/System.IO.Compression/BrotliDecoder.xml

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -71,19 +71,11 @@
7171
<param name="bytesWritten">The total number of bytes that were written in the <paramref name="destination" />.</param>
7272
<summary>Decompresses data that was compressed using the Brotli algorithm.</summary>
7373
<returns>One of the enumeration values that indicates the status of the decompression operation.</returns>
74-
<remarks>
75-
<format type="text/markdown"><![CDATA[
76-
77-
## Remarks
78-
79-
The return value can be as follows:
80-
- <xref:System.Buffers.OperationStatus.Done?displayProperty=nameWithType>: `source` was successfully and completely decompressed into `destination`.
81-
- <xref:System.Buffers.OperationStatus.DestinationTooSmall?displayProperty=nameWithType>: There is not enough space in `destination` to decompress `source`.
82-
- <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType>: The decompression action is partially done at least one more byte is required to complete the decompression task. This method should be called again with more input to decompress.
83-
- <xref:System.Buffers.OperationStatus.InvalidData?displayProperty=nameWithType>: The data in `source` is invalid and could not be decompressed.
84-
85-
]]></format>
86-
</remarks>
74+
<remarks>The return value can be as follows:
75+
- <see cref="F:System.Buffers.OperationStatus.Done" />: <paramref name="source" /> was successfully and completely decompressed into <paramref name="destination" />.
76+
- <see cref="F:System.Buffers.OperationStatus.DestinationTooSmall" />: There is not enough space in <paramref name="destination" /> to decompress <paramref name="source" />.
77+
- <see cref="F:System.Buffers.OperationStatus.NeedMoreData" />: The decompression action is partially done at least one more byte is required to complete the decompression task. This method should be called again with more input to decompress.
78+
- <see cref="F:System.Buffers.OperationStatus.InvalidData" />: The data in <paramref name="source" /> is invalid and could not be decompressed.</remarks>
8779
</Docs>
8880
</Member>
8981
<Member MemberName="Dispose">
@@ -153,15 +145,7 @@ The return value can be as follows:
153145
<summary>Attempts to decompress data that was compressed with the Brotli algorithm.</summary>
154146
<returns>
155147
<see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
156-
<remarks>
157-
<format type="text/markdown"><![CDATA[
158-
159-
## Remarks
160-
161-
If this method returns `false`, `destination` may be empty or contain partially decompressed data, with `bytesWritten` being zero or greater than zero but less than the expected total.
162-
163-
]]></format>
164-
</remarks>
148+
<remarks>If this method returns <see langword="false" />, <paramref name="destination" /> may be empty or contain partially decompressed data, with <paramref name="bytesWritten" /> being zero or greater than zero but less than the expected total.</remarks>
165149
</Docs>
166150
</Member>
167151
</Members>

xml/System.IO.Compression/BrotliEncoder.xml

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,8 @@
6666
<remarks>To be added.</remarks>
6767
<exception cref="T:System.ArgumentOutOfRangeException">
6868
<paramref name="quality" /> is not between the minimum value of 0 and the maximum value of 11.
69-
70-
-or-
71-
72-
<paramref name="window" /> is not between the minimum value of 10 and the maximum value of 24.
73-
</exception>
69+
-or-
70+
<paramref name="window" /> is not between the minimum value of 10 and the maximum value of 24.</exception>
7471
<exception cref="T:System.IO.IOException">Failed to create the <see cref="T:System.IO.Compression.BrotliEncoder" /> instance.</exception>
7572
</Docs>
7673
</Member>
@@ -213,15 +210,7 @@
213210
<param name="inputSize">The input size to get the maximum expected compressed length from. Must be greater or equal than 0 and less or equal than <see cref="F:System.Int32.MaxValue" /> - 515.</param>
214211
<summary>Gets the maximum expected compressed length for the provided input size.</summary>
215212
<returns>A number representing the maximum compressed length for the provided input size.</returns>
216-
<remarks>
217-
<format type="text/markdown"><![CDATA[
218-
219-
## Remarks
220-
221-
Returns 1 if `inputSize` is 0.
222-
223-
]]></format>
224-
</remarks>
213+
<remarks>Returns 1 if <paramref name="inputSize" /> is 0.</remarks>
225214
<exception cref="T:System.ArgumentOutOfRangeException">
226215
<paramref name="inputSize" /> is less than 0, the minimum allowed input size, or greater than <see cref="F:System.Int32.MaxValue" /> - 515, the maximum allowed input size.</exception>
227216
</Docs>

0 commit comments

Comments
 (0)