You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// These are the <xref:MyNamespace.MyEnum> enum remarks. They contain an [!INCLUDE[MyInclude](~/includes/MyInclude.md)] which should prevent converting markdown to xml.
8
-
/// URL entities: %23%28%2C%29 must remain unconverted.
9
-
/// ]]></format></remarks>
10
5
// Original MyEnum enum comments with information for maintainers, must stay.
6
+
/// <summary>This is the MyEnum enum summary.</summary>
7
+
/// <remarks>These are the <see cref="MyNamespace.MyEnum" /> enum remarks. They contain an [!INCLUDE[MyInclude](~/includes/MyInclude.md)] which should prevent converting markdown to xml.
8
+
/// URL entities: %23%28%2C%29 must remain unconverted.</remarks>
11
9
publicenumMyEnum
12
10
{
13
11
/// <summary>This is the MyEnumValue0 member summary. There is no public modifier.</summary>
@@ -17,6 +15,7 @@ public enum MyEnum
17
15
MyEnumValue1=1
18
16
}
19
17
18
+
// Original MyType class comments with information for maintainers, must stay.
20
19
/// <summary>This is the MyType class summary.</summary>
21
20
/// <remarks>These are the <see cref="MyNamespace.MyType" /> class remarks.
22
21
/// URL entities: #(),.
@@ -27,12 +26,11 @@ public enum MyEnum
27
26
/// ]]></format>
28
27
/// This text is not a note. It has a <see cref="MyNamespace.MyType" /> that should be xml and outside <b>the cdata</b>.
29
28
/// Long xrefs one after the other: <see cref="System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> or <see cref="System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{byte},System.Threading.CancellationToken)" /> should both be converted to crefs.</remarks>
30
-
// Original MyType class comments with information for maintainers, must stay.
31
29
publicclassMyType
32
30
{
33
-
/// <summary>This is the MyType constructor summary.</summary>
34
31
// Original MyType constructor double slash comments on top of triple slash, with information for maintainers, must stay but after triple slash.
35
32
// Original MyType constructor double slash comments on bottom of triple slash, with information for maintainers, must stay.
33
+
/// <summary>This is the MyType constructor summary.</summary>
// Double slash comments above private members should remain untouched.
52
50
privateint_myProperty;
53
51
52
+
// Original MyProperty property double slash comments with information for maintainers, must stay.
53
+
// This particular example has two rows of double slash comments and both should stay.
54
54
/// <summary>This is the MyProperty summary.</summary>
55
55
/// <value>This is the MyProperty value.</value>
56
56
/// <remarks>These are the MyProperty remarks.
57
57
/// Multiple lines and a reference to the field <see cref="MyNamespace.MyType.MyField" /> and the xref uses displayProperty, which should be ignored when porting.</remarks>
58
-
// Original MyProperty property double slash comments with information for maintainers, must stay.
59
-
// This particular example has two rows of double slash comments and both should stay.
60
58
publicintMyProperty
61
59
{
62
60
get{return_myProperty;/* Internal comments should remain untouched. */}
@@ -139,6 +137,7 @@ public void MyTypeParamMethod<T>(int param1)
139
137
{
140
138
}
141
139
140
+
// Original MyDelegate delegate comments with information for maintainers, must stay.
142
141
/// <summary>This is the MyDelegate summary.</summary>
143
142
/// <param name="sender">This is the sender parameter.</param>
144
143
/// <remarks>These are the <see cref="MyNamespace.MyType.MyDelegate" /> remarks. There is a code example, which should be moved to its own examples section:</remarks>
@@ -153,18 +152,17 @@ public void MyTypeParamMethod<T>(int param1)
// Original MyDelegate delegate comments with information for maintainers, must stay.
157
155
publicdelegatevoidMyDelegate(objectsender);
158
156
159
157
/// <summary>This is the MyEvent summary.</summary>
160
158
publiceventMyDelegateMyEvent;
161
159
160
+
// Original operator + method comments with information for maintainers, must stay.
162
161
/// <summary>Adds two MyType instances.</summary>
163
162
/// <param name="value1">The first type to add.</param>
164
163
/// <param name="value2">The second type to add.</param>
165
164
/// <returns>The added types.</returns>
166
165
/// <remarks>These are the <see cref="MyNamespace.MyType.op_Addition(MyNamespace.MyType,MyNamespace.MyType)" /> remarks. They are in plain xml and should be transferred unmodified.</remarks>
167
-
// Original operator + method comments with information for maintainers, must stay.
0 commit comments