Update ObsoleteAttribute remarks to account for new properties (dotnet#4984)

gewarren · web-flow · commit b812f4912c70 · 2020-10-14T16:42:51.000-07:00
diff --git a/xml/System/ObsoleteAttribute.xml b/xml/System/ObsoleteAttribute.xml
@@ -54,43 +54,41 @@
   <Docs>
     <summary>Marks the program elements that are no longer in use. This class cannot be inherited.</summary>
     <remarks>
-      <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- <xref:System.ObsoleteAttribute> is applicable to all program elements except assemblies, modules, parameters, and return values. Marking an element as obsolete informs users that the element will be removed in future versions of the product.  
-  
- The <xref:System.ObsoleteAttribute> class includes two properties:  
-  
--   <xref:System.ObsoleteAttribute.Message%2A>. The string assigned to the <xref:System.ObsoleteAttribute.Message%2A> property is emitted by the compiler when the attribute target is used in code. The string should note that the attribute target is obsolete and, if possible, provide some workaround or programmatic alternative.  
-  
--   <xref:System.ObsoleteAttribute.IsError%2A>. This is a Boolean value that indicates to the compiler whether using the <xref:System.ObsoleteAttribute> attribute should cause it to emit an error (<xref:System.ObsoleteAttribute.IsError%2A> is `true`) or a warning (<xref:System.ObsoleteAttribute.IsError%2A> is `false`).  
-  
- For more information about using attributes, see [Attributes](/dotnet/standard/attributes/).  
-  
-## [!INCLUDE[win8_appname_long](~/includes/win8-appname-long-md.md)] Apps  
- When you create a Windows Metadata library (.winmd file), the <xref:System.ObsoleteAttribute> is exported as both the <xref:System.ObsoleteAttribute> attribute and the [Windows.Foundation.Metadata.DeprecatedAttribute](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecatedattribute.aspx) attribute if only the <xref:System.ObsoleteAttribute> is present in source code. The <xref:System.ObsoleteAttribute> is transformed to the `DeprecatedAttribute` as follows:  
-  
--   If the `message` and `error` arguments are both present, `message` is assigned to the `DeprecatedAttribute` `message` argument. An error value of `true` maps to [DeprecationType.Remove](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecationtype.aspx), and an `error` value of `false` maps to [DeprecationType.Deprecate](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecationtype.aspx).  
-  
--   If the `message` argument is not supplied in the <xref:System.ObsoleteAttribute>, its default value in the `DeprecatedAttribute` is "*element_name* is deprecated", where *element_name* is the name of the target program element to which the attribute is applied.  
-  
--   If the `error` argument is not present in the <xref:System.ObsoleteAttribute>, its default value in the `DeprecatedAttribute` is [DeprecationType.Deprecate](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecationtype.aspx).  
-  
+      <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+<xref:System.ObsoleteAttribute> is applicable to all program elements except assemblies, modules, parameters, and return values. Marking an element as obsolete informs users that the element may be removed in a future version of the product.
+
+The string assigned to the <xref:System.ObsoleteAttribute.Message%2A> property is emitted by the compiler when the attribute target is used in code. Ideally, the string should provide some workaround or programmatic alternative.
+
+Use the <xref:System.ObsoleteAttribute.IsError%2A> property to indicate to the compiler whether using the <xref:System.ObsoleteAttribute> attribute should cause it to emit an error (<xref:System.ObsoleteAttribute.IsError%2A> is `true`) or a warning (<xref:System.ObsoleteAttribute.IsError%2A> is `false`).
+
+For more information about using attributes, see [Attributes](/dotnet/standard/attributes/).
+
+## Windows 8.x Store apps
+
+ When you create a Windows Metadata library (.winmd file), the <xref:System.ObsoleteAttribute> is exported as both the <xref:System.ObsoleteAttribute> attribute and the [Windows.Foundation.Metadata.DeprecatedAttribute](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecatedattribute.aspx) attribute if only the <xref:System.ObsoleteAttribute> is present in source code. The <xref:System.ObsoleteAttribute> is transformed to the `DeprecatedAttribute` as follows:
+
+- If the `message` and `error` arguments are both present, `message` is assigned to the `DeprecatedAttribute` `message` argument. An error value of `true` maps to [DeprecationType.Remove](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecationtype.aspx), and an `error` value of `false` maps to [DeprecationType.Deprecate](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecationtype.aspx).
+
+- If the `message` argument is not supplied in the <xref:System.ObsoleteAttribute>, its default value in the `DeprecatedAttribute` is "*element_name* is deprecated", where *element_name* is the name of the target program element to which the attribute is applied.
+
+- If the `error` argument is not present in the <xref:System.ObsoleteAttribute>, its default value in the `DeprecatedAttribute` is [DeprecationType.Deprecate](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecationtype.aspx).
+
 > [!IMPORTANT]
->  Directly applying the [Windows.Foundation.Metadata.DeprecatedAttribute](https://msdn.microsoft.com/library/windows/apps/windows.foundation.metadata.deprecatedattribute.aspx) attribute to managed code is not recommended, because this export occurs automatically.  
-  
-   
-  
-## Examples  
- The following example defines a class that contains a property and a method that are marked with the <xref:System.ObsoleteAttribute> attribute. Accessing the value of the `OldProperty` property in code generates a compiler warning, but calling the `CallOldMethod` method generates a compiler error. The example also shows the output that results when you attempt to compile the source code.  
-  
+> Directly applying the [Windows.Foundation.Metadata.DeprecatedAttribute](/uwp/api/Windows.Foundation.Metadata.DeprecatedAttribute) attribute to managed code is not recommended, because this export occurs automatically.
+
+## Examples
+ The following example defines a class that contains a property and a method that are marked with the <xref:System.ObsoleteAttribute> attribute. Accessing the value of the `OldProperty` property in code generates a compiler warning, but calling the `CallOldMethod` method generates a compiler error. The example also shows the output that results when you attempt to compile the source code.
+
  [!code-csharp[ObsoleteAttribute#1](~/samples/snippets/csharp/VS_Snippets_CLR/ObsoleteAttribute/CS/obsoleteattributeex1.cs#1)]
- [!code-vb[ObsoleteAttribute#1](~/samples/snippets/visualbasic/VS_Snippets_CLR/ObsoleteAttribute/vb/obsoleteattributeex1.vb#1)]  
-  
+ [!code-vb[ObsoleteAttribute#1](~/samples/snippets/visualbasic/VS_Snippets_CLR/ObsoleteAttribute/vb/obsoleteattributeex1.vb#1)]
+
  ]]></format>
     </remarks>
     <altmember cref="T:System.Attribute" />
-    <related type="Article" href="/dotnet/standard/attributes/">Extending Metadata Using Attributes</related>
+    <related type="Article" href="/dotnet/standard/attributes/">Extend metadata using attributes</related>
   </Docs>
   <Members>
     <MemberGroup MemberName=".ctor">
@@ -140,16 +138,18 @@
       <Docs>
         <summary>Initializes a new instance of the <see cref="T:System.ObsoleteAttribute" /> class with default properties.</summary>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- The following table shows the initial property values for an instance of <xref:System.ObsoleteAttribute>.  
-  
-|Property|Value|  
-|--------------|-----------|  
-|<xref:System.ObsoleteAttribute.IsError%2A>|`false`|  
-|<xref:System.ObsoleteAttribute.Message%2A>|`null`|  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ The following table shows the initial property values for an instance of <xref:System.ObsoleteAttribute>.
+
+|Property|Value|
+|--------------|-----------|
+|<xref:System.ObsoleteAttribute.IsError%2A>|`false`|
+|<xref:System.ObsoleteAttribute.Message%2A>|`null`|
+|<xref:System.ObsoleteAttribute.DiagnosticId>|`null`|
+|<xref:System.ObsoleteAttribute.UrlFormat>|`null`|
+
  ]]></format>
         </remarks>
       </Docs>
@@ -192,16 +192,18 @@
         <param name="message">The text string that describes alternative workarounds.</param>
         <summary>Initializes a new instance of the <see cref="T:System.ObsoleteAttribute" /> class with a specified workaround message.</summary>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- The following table shows the initial property values for an instance of <xref:System.ObsoleteAttribute>.  
-  
-|Property|Value|  
-|--------------|-----------|  
-|<xref:System.ObsoleteAttribute.IsError%2A>|`false`.|  
-|<xref:System.ObsoleteAttribute.Message%2A>|The workaround message.|  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ The following table shows the initial property values for an instance of <xref:System.ObsoleteAttribute>.
+
+|Property|Value|
+|--------------|-----------|
+|<xref:System.ObsoleteAttribute.IsError%2A>|`false`.|
+|<xref:System.ObsoleteAttribute.Message%2A>|The workaround message.|
+|<xref:System.ObsoleteAttribute.DiagnosticId>|`null`.|
+|<xref:System.ObsoleteAttribute.UrlFormat>|`null`.|
+
  ]]></format>
         </remarks>
       </Docs>
@@ -247,16 +249,18 @@
           <see langword="true" /> if the obsolete element usage generates a compiler error; <see langword="false" /> if it generates a compiler warning.</param>
         <summary>Initializes a new instance of the <see cref="T:System.ObsoleteAttribute" /> class with a workaround message and a Boolean value indicating whether the obsolete element usage is considered an error.</summary>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- The following table shows the initial property values for an instance of <xref:System.ObsoleteAttribute>.  
-  
-|Property|Value|  
-|--------------|-----------|  
-|<xref:System.ObsoleteAttribute.IsError%2A>|The `error` value.|  
-|<xref:System.ObsoleteAttribute.Message%2A>|The `message` value.|  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ The following table shows the initial property values for an instance of <xref:System.ObsoleteAttribute>.
+
+|Property|Value|
+|--------------|-----------|
+|<xref:System.ObsoleteAttribute.IsError%2A>|The `error` value.|
+|<xref:System.ObsoleteAttribute.Message%2A>|The `message` value.|
+|<xref:System.ObsoleteAttribute.DiagnosticId>|`null`.|
+|<xref:System.ObsoleteAttribute.UrlFormat>|`null`.|
+
  ]]></format>
         </remarks>
       </Docs>
@@ -283,9 +287,19 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>Gets or sets the ID the compiler will use when reporting a use of the API.</summary>
+        <summary>Gets or sets the ID that the compiler will use when reporting a use of the API.</summary>
         <value>The unique diagnostic ID.</value>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+The diagnostic ID is shown in build output for warnings and errors.
+
+This property represents the unique ID that can be used to suppress the warnings or errors, if needed.
+
+       ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsError">
@@ -323,18 +337,18 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>Gets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error.</summary>
+        <summary>Gets a value that indicates whether the compiler will treat usage of the obsolete program element as an error.</summary>
         <value>
           <see langword="true" /> if the obsolete element usage is considered an error; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Examples  
- The following example defines a class that contains two members marked as obsolete. The first, a property named `OldProperty`, produces a compiler warning if it is called. The second, a method named `CallOldMethod`, produces a compiler error. The example uses reflection to get information about the <xref:System.ObsoleteAttribute> attributes applied to members of the type and displays the values of their <xref:System.ObsoleteAttribute.Message%2A> and <xref:System.ObsoleteAttribute.IsError%2A> properties.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Examples
+ The following example defines a class that contains two members marked as obsolete. The first, a property named `OldProperty`, produces a compiler warning if it is called. The second, a method named `CallOldMethod`, produces a compiler error. The example uses reflection to get information about the <xref:System.ObsoleteAttribute> attributes applied to members of the type and displays the values of their <xref:System.ObsoleteAttribute.Message%2A> and <xref:System.ObsoleteAttribute.IsError%2A> properties.
+
  [!code-csharp[System.ObsoleteAttribute.Message#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.obsoleteattribute.message/cs/obsoleteattribute_message.cs#1)]
- [!code-vb[System.ObsoleteAttribute.Message#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.obsoleteattribute.message/vb/obsoleteattribute_message.vb#1)]  
-  
+ [!code-vb[System.ObsoleteAttribute.Message#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.obsoleteattribute.message/vb/obsoleteattribute_message.vb#1)]
+
  ]]></format>
         </remarks>
       </Docs>
@@ -374,17 +388,17 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>Gets the workaround message, including a description of the alternative program elements.</summary>
+        <summary>Gets the workaround message.</summary>
         <value>The workaround text string.</value>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Examples  
- The following example defines a class that contains two members marked as obsolete. The first, a property named `OldProperty`, produces a compiler warning if it is called. The second, a method named `CallOldMethod`, produces a compiler error. The example uses reflection to get information about the <xref:System.ObsoleteAttribute> attributes applied to members of the type and displays the values of their <xref:System.ObsoleteAttribute.Message%2A> and <xref:System.ObsoleteAttribute.IsError%2A> properties.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Examples
+ The following example defines a class that contains two members marked as obsolete. The first, a property named `OldProperty`, produces a compiler warning if it is called. The second, a method named `CallOldMethod`, produces a compiler error. The example uses reflection to get information about the <xref:System.ObsoleteAttribute> attributes applied to members of the type and displays the values of their <xref:System.ObsoleteAttribute.Message%2A> and <xref:System.ObsoleteAttribute.IsError%2A> properties.
+
  [!code-csharp[System.ObsoleteAttribute.Message#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.obsoleteattribute.message/cs/obsoleteattribute_message.cs#1)]
- [!code-vb[System.ObsoleteAttribute.Message#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.obsoleteattribute.message/vb/obsoleteattribute_message.vb#1)]  
-  
+ [!code-vb[System.ObsoleteAttribute.Message#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.obsoleteattribute.message/vb/obsoleteattribute_message.vb#1)]
+
  ]]></format>
         </remarks>
       </Docs>
@@ -413,7 +427,15 @@
       <Docs>
         <summary>Gets or sets the URL for corresponding documentation. The API accepts a format string instead of an actual URL, creating a generic URL that includes the diagnostic ID.</summary>
         <value>The format string that represents a URL to corresponding documentation.</value>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+An example format string is `https://contoso.com/obsoletion-warnings/{0}`.
+
+       ]]></format>
+        </remarks>
       </Docs>
     </Member>
   </Members>
