Skip to content

Commit 7ae2979

Browse files
mairawRon Petrusha
mairaw
and
Ron Petrusha
authored
Markdig migration (#3003)
* Switch to markdown engine * Update DateTime.xml * recover rest of the file * markdig fixes * add missing backtick * escape * * remove note blocks * remove note block * codefence non-working url * undo some changes * Apply suggestions from docs review Co-Authored-By: Ron Petrusha <[email protected]>
1 parent 64dcbe4 commit 7ae2979

File tree

6 files changed

+96
-64
lines changed

6 files changed

+96
-64
lines changed

‎docfx.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"build": {
3-
"markdownEngineName": "dfm-latest",
3+
"markdownEngineName": "markdig",
44
"content": [
55
{
66
"files": [

‎xml/System.Security.Cryptography/TripleDESCryptoServiceProvider.xml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -339,10 +339,7 @@
339339
<param name="rgbKey">The secret key to use for the symmetric algorithm.</param>
340340
<param name="rgbIV">The initialization vector to use for the symmetric algorithm.
341341

342-
<block subset="none" type="note"><para>
343-
The initialization vector must be 8 bytes long. If it is longer than 8 bytes, it is truncated and an exception is not thrown. Before you call <see cref="M:System.Security.Cryptography.TripleDESCryptoServiceProvider.CreateEncryptor(System.Byte[],System.Byte[])" />, check the length of the initialization vector and throw an exception if it is too long.
344-
345-
</para></block></param>
342+
<para>Note: The initialization vector must be 8 bytes long. If it is longer than 8 bytes, it is truncated and an exception is not thrown. Before you call <see cref="M:System.Security.Cryptography.TripleDESCryptoServiceProvider.CreateEncryptor(System.Byte[],System.Byte[])" />, check the length of the initialization vector and throw an exception if it is too long.</para></param>
346343
<summary>Creates a symmetric <see cref="T:System.Security.Cryptography.TripleDES" /> encryptor object with the specified key (<see cref="P:System.Security.Cryptography.SymmetricAlgorithm.Key" />) and initialization vector (<see cref="P:System.Security.Cryptography.SymmetricAlgorithm.IV" />).</summary>
347344
<returns>A symmetric <see cref="T:System.Security.Cryptography.TripleDES" /> encryptor object.</returns>
348345
<remarks>

‎xml/System.Threading.Tasks/TaskFactory.xml

Lines changed: 66 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -621,7 +621,11 @@ The following example creates a cancellation token, which it passes to separate
621621
<returns>The new continuation task.</returns>
622622
<remarks>
623623
<format type="text/markdown"><![CDATA[
624-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
624+
625+
## Remarks
626+
627+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
628+
625629
]]></format>
626630
</remarks>
627631
<exception cref="T:System.ObjectDisposedException">An element in the <paramref name="tasks" /> array has been disposed.</exception>
@@ -683,7 +687,11 @@ The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, wh
683687
<returns>The new continuation task.</returns>
684688
<remarks>
685689
<format type="text/markdown"><![CDATA[
686-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
690+
691+
## Remarks
692+
693+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
694+
687695
]]></format>
688696
</remarks>
689697
<exception cref="T:System.ArgumentNullException">The <paramref name="tasks" /> array is <see langword="null" />.
@@ -870,7 +878,11 @@ The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, wh
870878
<returns>The new continuation task.</returns>
871879
<remarks>
872880
<format type="text/markdown"><![CDATA[
873-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
881+
882+
## Remarks
883+
884+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
885+
874886
]]></format>
875887
</remarks>
876888
<exception cref="T:System.ObjectDisposedException">An element in the <paramref name="tasks" /> array has been disposed.</exception>
@@ -937,7 +949,11 @@ The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, wh
937949
<returns>The new continuation task.</returns>
938950
<remarks>
939951
<format type="text/markdown"><![CDATA[
940-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
952+
953+
## Remarks
954+
955+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
956+
941957
]]></format>
942958
</remarks>
943959
<exception cref="T:System.ArgumentNullException">The <paramref name="tasks" /> array is <see langword="null" />.
@@ -1124,7 +1140,11 @@ The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, wh
11241140
<returns>The new continuation task.</returns>
11251141
<remarks>
11261142
<format type="text/markdown"><![CDATA[
1127-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
1143+
1144+
## Remarks
1145+
1146+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
1147+
11281148
]]></format>
11291149
</remarks>
11301150
<exception cref="T:System.ObjectDisposedException">An element in the <paramref name="tasks" /> array has been disposed.</exception>
@@ -1191,7 +1211,11 @@ The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, wh
11911211
<returns>The new continuation task.</returns>
11921212
<remarks>
11931213
<format type="text/markdown"><![CDATA[
1194-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
1214+
1215+
## Remarks
1216+
1217+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
1218+
11951219
]]></format>
11961220
</remarks>
11971221
<exception cref="T:System.ArgumentNullException">The <paramref name="tasks" /> array is <see langword="null" />.
@@ -1385,7 +1409,11 @@ The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, wh
13851409
<returns>The new continuation task.</returns>
13861410
<remarks>
13871411
<format type="text/markdown"><![CDATA[
1388-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
1412+
1413+
## Remarks
1414+
1415+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
1416+
13891417
]]></format>
13901418
</remarks>
13911419
<exception cref="T:System.ObjectDisposedException">An element in the <paramref name="tasks" /> array has been disposed.</exception>
@@ -1454,7 +1482,11 @@ The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, wh
14541482
<returns>The new continuation task.</returns>
14551483
<remarks>
14561484
<format type="text/markdown"><![CDATA[
1457-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
1485+
1486+
## Remarks
1487+
1488+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAll`.
1489+
14581490
]]></format>
14591491
</remarks>
14601492
<exception cref="T:System.ArgumentNullException">The <paramref name="tasks" /> array is <see langword="null" />.
@@ -1666,8 +1698,9 @@ The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, wh
16661698
<remarks>
16671699
<format type="text/markdown"><![CDATA[
16681700
1669-
## Remarks
1670-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with ContinueWhenAny.
1701+
## Remarks
1702+
1703+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
16711704
16721705
]]></format>
16731706
</remarks>
@@ -1736,7 +1769,11 @@ The <paramref name="tasks" /> array is empty.</exception>
17361769
<returns>The new continuation <see cref="T:System.Threading.Tasks.Task" />.</returns>
17371770
<remarks>
17381771
<format type="text/markdown"><![CDATA[
1739-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
1772+
1773+
## Remarks
1774+
1775+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
1776+
17401777
]]></format>
17411778
</remarks>
17421779
<exception cref="T:System.ArgumentNullException">The <paramref name="tasks" /> array is <see langword="null" />.
@@ -1938,7 +1975,8 @@ The <paramref name="tasks" /> array is empty.</exception>
19381975
<format type="text/markdown"><![CDATA[
19391976
19401977
## Remarks
1941-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with ContinueWhenAny.
1978+
1979+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
19421980
19431981
]]></format>
19441982
</remarks>
@@ -2012,8 +2050,9 @@ The <paramref name="tasks" /> array is empty.</exception>
20122050
<remarks>
20132051
<format type="text/markdown"><![CDATA[
20142052
2015-
## Remarks
2016-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with ContinueWhenAny.
2053+
## Remarks
2054+
2055+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
20172056
20182057
]]></format>
20192058
</remarks>
@@ -2215,8 +2254,9 @@ The <paramref name="tasks" /> array is empty.</exception>
22152254
<remarks>
22162255
<format type="text/markdown"><![CDATA[
22172256
2218-
## Remarks
2219-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with ContinueWhenAny.
2257+
## Remarks
2258+
2259+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
22202260
22212261
]]></format>
22222262
</remarks>
@@ -2290,9 +2330,10 @@ The <paramref name="tasks" /> array is empty.</exception>
22902330
<remarks>
22912331
<format type="text/markdown"><![CDATA[
22922332
2293-
## Remarks
2294-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with ContinueWhenAny.
2295-
2333+
## Remarks
2334+
2335+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
2336+
22962337
]]></format>
22972338
</remarks>
22982339
<exception cref="T:System.ArgumentNullException">The <paramref name="tasks" /> array is <see langword="null" />.
@@ -2499,8 +2540,9 @@ The <paramref name="tasks" /> array is empty.</exception>
24992540
<remarks>
25002541
<format type="text/markdown"><![CDATA[
25012542
2502-
## Remarks
2503-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with ContinueWhenAny.
2543+
## Remarks
2544+
2545+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
25042546
25052547
]]></format>
25062548
</remarks>
@@ -2576,8 +2618,9 @@ The <paramref name="tasks" /> array is empty.</exception>
25762618
<remarks>
25772619
<format type="text/markdown"><![CDATA[
25782620
2579-
## Remarks
2580-
The NotOn* and OnlyOn* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with ContinueWhenAny.
2621+
## Remarks
2622+
2623+
The NotOn\* and OnlyOn\* <xref:System.Threading.Tasks.TaskContinuationOptions>, which constrain for which <xref:System.Threading.Tasks.TaskStatus> states a continuation will be executed, are illegal with `ContinueWhenAny`.
25812624
25822625
]]></format>
25832626
</remarks>

‎xml/System.Xml/XmlNode.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -280,16 +280,16 @@ Display the modified XML...
280280
<!ATTLIST baa attr1 "woof">
281281
```
282282
283-
If the XML document is loaded from http://localhost/mydata.xml, `BaseURI` returns the following for each of the nodes:
283+
If the XML document is loaded from `http://localhost/mydata.xml`, `BaseURI` returns the following for each of the nodes:
284284
285285
|NodeType|Name|BaseURI|
286286
|--------------|----------|-------------|
287-
|Document|#document|http://localhost/mydata.xml|
288-
|DocumentType|Mydata|http://localhost/mydata.xml<br /><br /> The <xref:System.Xml.XmlDocumentType.SystemId%2A?displayProperty=nameWithType> or <xref:System.Xml.XmlDocumentType.PublicId%2A?displayProperty=nameWithType> properties can be used to identify where the DTD file was loaded from.|
289-
|Element|baa|http://localhost/mydata.xml|
290-
|Entity|xyz|http://localhost/doctype.dtd|
291-
|EntityReference|xyz|http://localhost/mydata.xml|
292-
|Attribute|woof|http://localhost/mydata.xml|
287+
|Document|#document|`http://localhost/mydata.xml`|
288+
|DocumentType|Mydata|`http://localhost/mydata.xml`<br /><br /> The <xref:System.Xml.XmlDocumentType.SystemId%2A?displayProperty=nameWithType> or <xref:System.Xml.XmlDocumentType.PublicId%2A?displayProperty=nameWithType> properties can be used to identify where the DTD file was loaded from.|
289+
|Element|baa|`http://localhost/mydata.xml`|
290+
|Entity|xyz|`http://localhost/doctype.dtd`|
291+
|EntityReference|xyz|`http://localhost/mydata.xml`|
292+
|Attribute|woof|`http://localhost/mydata.xml`|
293293
294294
> [!NOTE]
295295
> The base URI of a default attribute is the same as the base URI of the element to which they belong.

‎xml/System/DateTime.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5226,12 +5226,12 @@ The following example parses an array of date strings by using the conventions o
52265226

52275227
This method overload converts the date and time in `s` and sets the <xref:System.DateTime.Kind%2A> property of the returned <xref:System.DateTime> value as follows:
52285228

5229-
|If |Time zone conversion|Kind property|
5230-
|-----|-----|-----|
5231-
|`s` contains no time zone information.|None.|<xref:System.DateTimeKind.Unspecified?displayProperty=nameWithType>|
5232-
|`s` contains time zone information.|To the time in the local time zone|<xref:System.DateTimeKind.Local?displayProperty=nameWithType>|
5233-
|`s` contains time zone information, and `styles includes the <xref:System.Globalization.DateTimeStyles.AdjustToUniversal?displayProperty=nameWithType> flag.|To Coordinated Universal Time (UTC)|<xref:System.DateTimeKind.Utc?displayProperty=nameWithType>|
5234-
|`s` contains the Z or GMT time zone designator, and `styles` includes the <xref:System.Globalization.DateTimeStyles.RoundtripKind?displayProperty=nameWithType>.|None.|<xref:System.DateTimeKind.Utc>|
5229+
| If | Time zone conversion | Kind property |
5230+
|----|----------------------|---------------|
5231+
| `s` contains no time zone information. | None. | <xref:System.DateTimeKind.Unspecified?displayProperty=nameWithType> |
5232+
| `s` contains time zone information. | To the time in the local time zone | <xref:System.DateTimeKind.Local?displayProperty=nameWithType> |
5233+
| `s` contains time zone information, and `styles` includes the <xref:System.Globalization.DateTimeStyles.AdjustToUniversal?displayProperty=nameWithType> flag. | To Coordinated Universal Time (UTC) | <xref:System.DateTimeKind.Utc?displayProperty=nameWithType> |
5234+
| `s` contains the Z or GMT time zone designator, and `styles` includes the <xref:System.Globalization.DateTimeStyles.RoundtripKind?displayProperty=nameWithType>. | None. | <xref:System.DateTimeKind.Utc?displayProperty=nameWithType> |
52355235

52365236
## Example
52375237

0 commit comments

Comments
 (0)