Skip to content

Commit ea2e372

Browse files
authored
Removing "see remarks" language (dotnet#2032)
* Initial commit Update Update Update * Removing more instances
1 parent ec57b79 commit ea2e372

File tree

122 files changed

+438
-440
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+438
-440
lines changed

xml/System.ComponentModel/PropertyDescriptor.xml

+2-4
Original file line numberDiff line numberDiff line change
@@ -1187,11 +1187,9 @@
11871187
]]></format>
11881188
</remarks>
11891189
<block subset="none" type="overrides">
1190-
<para>When overridden in a derived class, this method returns <see langword="true" /> if the current value of the property is different from its default value. It looks for a default value by first looking for a <see cref="T:System.ComponentModel.DefaultValueAttribute" />. If the method finds this attribute, it compares the value of the attribute with the property's current value. If this method cannot find a <see cref="T:System.ComponentModel.DefaultValueAttribute" />, it looks for a "ShouldSerializeMyProperty" method that you need to implement. If it is found, <see cref="M:System.ComponentModel.PropertyDescriptor.ShouldSerializeValue(System.Object)" /> invokes it. If this method cannot find a <see cref="T:System.ComponentModel.DefaultValueAttribute" /> or a "ShouldSerializeMyProperty" method, it cannot create optimizations and it returns <see langword="true" />.
1191-
1190+
<para>When overridden in a derived class, this method returns <see langword="true" /> if the current value of the property is different from its default value. It looks for a default value by first looking for a <see cref="T:System.ComponentModel.DefaultValueAttribute" />. If the method finds this attribute, it compares the value of the attribute with the property's current value. If this method cannot find a <see cref="T:System.ComponentModel.DefaultValueAttribute" />, it looks for a "ShouldSerializeMyProperty" method that you need to implement. If it is found, <see cref="M:System.ComponentModel.PropertyDescriptor.ShouldSerializeValue(System.Object)" /> invokes it. If this method cannot find a <see cref="T:System.ComponentModel.DefaultValueAttribute" /> or a "ShouldSerializeMyProperty" method, it cannot create optimizations and it returns <see langword="true" />.
11921191
<block subset="none" type="note"><para>
1193-
The <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class implements special serialization logic for inherited components. For more information, see the remarks in <see cref="T:System.ComponentModel.Design.ComponentDesigner" />.
1194-
1192+
The <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class implements special serialization logic for inherited components. For more information, see <see cref="T:System.ComponentModel.Design.ComponentDesigner" />.
11951193
</para></block></para>
11961194
</block>
11971195
</Docs>

xml/System.ComponentModel/PropertyFilterOptions.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
<ReturnType>System.ComponentModel.PropertyFilterOptions</ReturnType>
5858
</ReturnValue>
5959
<Docs>
60-
<summary>Return only those properties that are not valid given the current context of the object. See Remarks.</summary>
60+
<summary>Return only those properties that are not valid given the current context of the object.</summary>
6161
</Docs>
6262
</Member>
6363
<Member MemberName="None">
@@ -121,7 +121,7 @@
121121
<ReturnType>System.ComponentModel.PropertyFilterOptions</ReturnType>
122122
</ReturnValue>
123123
<Docs>
124-
<summary>Return any property that is valid on the object in the current scope. See Remarks.</summary>
124+
<summary>Return any property that is valid on the object in the current scope.</summary>
125125
</Docs>
126126
</Member>
127127
</Members>

xml/System.Data.Common/DbDataReader.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ private static void GetDataTypes(String connectiongString) {
798798
<Parameter Name="ordinal" Type="System.Int32" />
799799
</Parameters>
800800
<Docs>
801-
<typeparam name="T">The type of the value to be returned. See the remarks section for more information.</typeparam>
801+
<typeparam name="T">The type of the value to be returned.</typeparam>
802802
<param name="ordinal">The type of the value to be returned.</param>
803803
<summary>Asynchronously gets the value of the specified column as a type.</summary>
804804
<returns>The type of the value to be returned.</returns>
@@ -862,7 +862,7 @@ private static void GetDataTypes(String connectiongString) {
862862
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
863863
</Parameters>
864864
<Docs>
865-
<typeparam name="T">The type of the value to be returned. See the remarks section for more information.</typeparam>
865+
<typeparam name="T">The type of the value to be returned.</typeparam>
866866
<param name="ordinal">The type of the value to be returned.</param>
867867
<param name="cancellationToken">The cancellation instruction, which propagates a notification that operations should be canceled. This does not guarantee the cancellation. A setting of <see langword="CancellationToken.None" /> makes this method equivalent to <see cref="M:System.Data.Common.DbDataReader.GetFieldValueAsync``1(System.Int32)" />. The returned task must be marked as cancelled.</param>
868868
<summary>Asynchronously gets the value of the specified column as a type.</summary>

xml/System.Data.Linq.Mapping/ColumnAttribute.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ public class Employees
174174
</ReturnValue>
175175
<Docs>
176176
<summary>Gets or sets the type of the database column.</summary>
177-
<value>See Remarks.</value>
177+
<value>String value that specifies the exact text that defines the column in a Transact-SQL table declaration.</value>
178178
<remarks>
179179
<format type="text/markdown"><![CDATA[
180180

xml/System.Data.SqlClient/SqlDataReader.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@
716716
<Parameter Name="i" Type="System.Int32" />
717717
</Parameters>
718718
<Docs>
719-
<typeparam name="T">The type of the value to be returned. See the remarks section for more information.</typeparam>
719+
<typeparam name="T">The type of the value to be returned.</typeparam>
720720
<param name="i">The column to be retrieved.</param>
721721
<summary>Synchronously gets the value of the specified column as a type. <see cref="M:System.Data.SqlClient.SqlDataReader.GetFieldValueAsync``1(System.Int32,System.Threading.CancellationToken)" /> is the asynchronous version of this method.</summary>
722722
<returns>The returned type object.</returns>
@@ -784,7 +784,7 @@
784784
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
785785
</Parameters>
786786
<Docs>
787-
<typeparam name="T">The type of the value to be returned. See the remarks section for more information.</typeparam>
787+
<typeparam name="T">The type of the value to be returned.</typeparam>
788788
<param name="i">The column to be retrieved.</param>
789789
<param name="cancellationToken">The cancellation instruction, which propagates a notification that operations should be canceled. This does not guarantee the cancellation. A setting of <see langword="CancellationToken.None" /> makes this method equivalent to <see cref="M:System.Data.SqlClient.SqlDataReader.IsDBNull(System.Int32)" />. The returned task must be marked as cancelled.</param>
790790
<summary>Asynchronously gets the value of the specified column as a type. <see cref="M:System.Data.SqlClient.SqlDataReader.GetFieldValue``1(System.Int32)" /> is the synchronous version of this method.</summary>

xml/System.Data/DataView.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1101,7 +1101,7 @@
11011101
</ReturnValue>
11021102
<Docs>
11031103
<summary>Gets or sets the expression used to filter which rows are viewed in the <see cref="T:System.Data.DataView" />.</summary>
1104-
<value>A string that specifies how rows are to be filtered. For more information, see the Remarks section.</value>
1104+
<value>A string that specifies how rows are to be filtered.</value>
11051105
<remarks>
11061106
<format type="text/markdown"><![CDATA[
11071107

xml/System.Diagnostics.Tracing/EventSource.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@
616616
<param name="assemblyPathToIncludeInManifest">The path to the assembly file (.dll) file to include in the [provider](http://msdn.microsoft.com/library/windows/desktop/aa384022\(v=vs.85\).aspx) element of the manifest.</param>
617617
<param name="flags">A bitwise combination of the enumeration values that specify how the manifest is generated.</param>
618618
<summary>Returns a string of the XML manifest that is associated with the current event source.</summary>
619-
<returns>The XML data string or <see langword="null" /> (see remarks).</returns>
619+
<returns>The XML data string or <see langword="null" />.</returns>
620620
<remarks>
621621
<format type="text/markdown"><![CDATA[
622622

xml/System.Diagnostics/Debug.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@
329329
<Docs>
330330
<param name="condition">The conditional expression to evaluate. If the condition is <see langword="true" />, the specified messages are not sent and the message box is not displayed.</param>
331331
<param name="message">The message to send to the <see cref="P:System.Diagnostics.Trace.Listeners" /> collection.</param>
332-
<param name="detailMessageFormat">The composite format string (see Remarks) to send to the <see cref="P:System.Diagnostics.Trace.Listeners" /> collection. This message contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
332+
<param name="detailMessageFormat">The composite format string to send to the <see cref="P:System.Diagnostics.Trace.Listeners" /> collection. This message contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
333333
<param name="args">An object array that contains zero or more objects to format.</param>
334334
<summary>Checks for a condition; if the condition is <see langword="false" />, outputs two messages (simple and formatted) and displays a message box that shows the call stack.</summary>
335335
<remarks>
@@ -872,7 +872,7 @@ End of list of errors
872872
</Parameter>
873873
</Parameters>
874874
<Docs>
875-
<param name="format">A composite format string (see Remarks) that contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
875+
<param name="format">A composite format string that contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
876876
<param name="args">An object array containing zero or more objects to format.</param>
877877
<summary>Writes a formatted string followed by a line terminator to the trace listeners in the <see cref="P:System.Diagnostics.Debug.Listeners" /> collection.</summary>
878878
<remarks>
@@ -1702,7 +1702,7 @@ Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");
17021702
</Parameter>
17031703
</Parameters>
17041704
<Docs>
1705-
<param name="format">A composite format string (see Remarks) that contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
1705+
<param name="format">A composite format string that contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
17061706
<param name="args">An object array that contains zero or more objects to format.</param>
17071707
<summary>Writes a formatted message followed by a line terminator to the trace listeners in the <see cref="P:System.Diagnostics.Debug.Listeners" /> collection.</summary>
17081708
<remarks>

xml/System.Diagnostics/TraceSource.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -783,7 +783,7 @@
783783
<Docs>
784784
<param name="eventType">One of the enumeration values that specifies the event type of the trace data.</param>
785785
<param name="id">A numeric identifier for the event.</param>
786-
<param name="format">A composite format string (see Remarks) that contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
786+
<param name="format">A composite format string that contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
787787
<param name="args">An <see langword="object" /> array containing zero or more objects to format.</param>
788788
<summary>Writes a trace event to the trace listeners in the <see cref="P:System.Diagnostics.TraceSource.Listeners" /> collection using the specified event type, event identifier, and argument array and format.</summary>
789789
<remarks>
@@ -904,7 +904,7 @@
904904
</Parameter>
905905
</Parameters>
906906
<Docs>
907-
<param name="format">A composite format string (see Remarks) that contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
907+
<param name="format">A composite format string that contains text intermixed with zero or more format items, which correspond to objects in the <c>args</c> array.</param>
908908
<param name="args">An array containing zero or more objects to format.</param>
909909
<summary>Writes an informational message to the trace listeners in the <see cref="P:System.Diagnostics.TraceSource.Listeners" /> collection using the specified object array and formatting information.</summary>
910910
<remarks>

xml/System.DirectoryServices.ActiveDirectory/Domain.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
<Docs>
5656
<param name="targetDomainName">The DNS name of the domain that the trust is created with.</param>
5757
<param name="direction">One of the <see cref="T:System.DirectoryServices.ActiveDirectory.TrustDirection" /> members that determines the direction of the trust, relative to this domain.</param>
58-
<param name="trustPassword">The password for the trust. See remarks below.</param>
58+
<param name="trustPassword">The password for the trust.</param>
5959
<summary>Creates the local side of a trust relationship with the specified domain.</summary>
6060
<remarks>
6161
<format type="text/markdown"><![CDATA[

xml/System.DirectoryServices.ActiveDirectory/Forest.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
<Docs>
6262
<param name="targetForestName">The DNS name of the forest that the trust is created with.</param>
6363
<param name="direction">One of the <see cref="T:System.DirectoryServices.ActiveDirectory.TrustDirection" /> members that determines the direction of the trust, relative to this forest.</param>
64-
<param name="trustPassword">The password for the trust. See the Remarks section for more information.</param>
64+
<param name="trustPassword">The password for the trust.</param>
6565
<summary>Creates the local side of a trust relationship with the specified forest.</summary>
6666
<remarks>
6767
<format type="text/markdown"><![CDATA[
@@ -609,7 +609,7 @@
609609
</Parameters>
610610
<Docs>
611611
<param name="targetForestName">The DNS name of the <see cref="T:System.DirectoryServices.ActiveDirectory.Forest" /> with which the inbound trust relationship exists.</param>
612-
<summary>Gets a Boolean value that indicates whether selective authentication is enabled on the inbound trust relationship with the specified forest. <see langword="true" /> if selective authentication is enabled; otherwise, <see langword="false" />. For more information, see the Remarks section.</summary>
612+
<summary>Gets a Boolean value that indicates whether selective authentication is enabled on the inbound trust relationship with the specified forest. <see langword="true" /> if selective authentication is enabled; otherwise, <see langword="false" />.</summary>
613613
<returns>
614614
<see langword="true" /> if selective authentication is enabled; otherwise, <see langword="false" />.</returns>
615615
<remarks>

xml/System.Globalization/PersianCalendar.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -899,7 +899,7 @@
899899
</ReturnValue>
900900
<Docs>
901901
<summary>Gets the latest date and time supported by the <see cref="T:System.Globalization.PersianCalendar" /> class.</summary>
902-
<value>The latest date and time supported by the <see cref="T:System.Globalization.PersianCalendar" /> class. See the Remarks section for more information.</value>
902+
<value>The latest date and time supported by the <see cref="T:System.Globalization.PersianCalendar" /> class.</value>
903903
<remarks>
904904
<format type="text/markdown"><![CDATA[
905905
@@ -943,7 +943,7 @@
943943
</ReturnValue>
944944
<Docs>
945945
<summary>Gets the earliest date and time supported by the <see cref="T:System.Globalization.PersianCalendar" /> class.</summary>
946-
<value>The earliest date and time supported by the <see cref="T:System.Globalization.PersianCalendar" /> class. See the Remarks section for more information.</value>
946+
<value>The earliest date and time supported by the <see cref="T:System.Globalization.PersianCalendar" /> class.</value>
947947
<remarks>
948948
<format type="text/markdown"><![CDATA[
949949

xml/System.IO.Compression/DeflateStream.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@
355355
<param name="count">The maximum number of bytes to read.</param>
356356
<param name="cback">To be added.</param>
357357
<param name="state">To be added.</param>
358-
<summary>Begins an asynchronous read operation. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead; see the Remarks section.)</summary>
358+
<summary>Begins an asynchronous read operation. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
359359
<returns>An object that represents the asynchronous read operation, which could still be pending.</returns>
360360
<remarks>
361361
<format type="text/markdown"><![CDATA[
@@ -412,7 +412,7 @@
412412
<param name="count">The maximum number of bytes to write.</param>
413413
<param name="cback">To be added.</param>
414414
<param name="state">To be added.</param>
415-
<summary>Begins an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> method instead; see the Remarks section.)</summary>
415+
<summary>Begins an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
416416
<returns>An object that represents the asynchronous write operation, which could still be pending.</returns>
417417
<remarks>
418418
<format type="text/markdown"><![CDATA[
@@ -595,7 +595,7 @@
595595
</Parameters>
596596
<Docs>
597597
<param name="async_result">To be added.</param>
598-
<summary>Waits for the pending asynchronous read to complete. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead; see the Remarks section.)</summary>
598+
<summary>Waits for the pending asynchronous read to complete. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
599599
<returns>The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. <see cref="T:System.IO.Compression.DeflateStream" /> returns 0 only at the end of the stream; otherwise, it blocks until at least one byte is available.</returns>
600600
<remarks>
601601
<format type="text/markdown"><![CDATA[
@@ -639,7 +639,7 @@
639639
</Parameters>
640640
<Docs>
641641
<param name="async_result">To be added.</param>
642-
<summary>Ends an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> method instead; see the Remarks section.)</summary>
642+
<summary>Ends an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
643643
<remarks>
644644
<format type="text/markdown"><![CDATA[
645645

0 commit comments

Comments
 (0)