Skip to content

Commit f81fc7e

Browse files
buyaa-ngewarren
andauthored
Add missing docs in FieldTypeEncoder.CustomModifiers, ObsoletedOSPlatformAttribute (#8424)
* Add missing docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 5268a7f commit f81fc7e

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

xml/System.Reflection.Metadata.Ecma335/FieldTypeEncoder.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@
8383
</ReturnValue>
8484
<Parameters />
8585
<Docs>
86-
<summary>Get <see cref="M:System.Reflection.Metadata.Ecma335.FieldTypeEncoder.CustomModifiers" /> to specify custom modifiers to the field signature.</summary>
87-
<returns>To be added.</returns>
86+
<summary>Gets the custom modifiers encoder to the field signature.</summary>
87+
<returns>The encoder that specifies the custom modifiers to the field signature.</returns>
8888
<remarks>To be added.</remarks>
8989
</Docs>
9090
</Member>

xml/System.Runtime.Versioning/ObsoletedOSPlatformAttribute.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040
<Parameter Name="platformName" Type="System.String" />
4141
</Parameters>
4242
<Docs>
43-
<param name="platformName">To be added.</param>
44-
<summary>To be added.</summary>
43+
<param name="platformName">The obsoleted OS platform name, optionally including a version.</param>
44+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Versioning.ObsoletedOSPlatformAttribute" /> class for the specified obsoleted OS platform.</summary>
4545
<remarks>To be added.</remarks>
4646
</Docs>
4747
</Member>
@@ -62,9 +62,9 @@
6262
<Parameter Name="message" Type="System.String" />
6363
</Parameters>
6464
<Docs>
65-
<param name="platformName">To be added.</param>
66-
<param name="message">To be added.</param>
67-
<summary>To be added.</summary>
65+
<param name="platformName">The obsoleted OS platform name, optionally including a version.</param>
66+
<param name="message">Additional information about the obsoletion, for example, a suggested alternative for the obsoleted API.</param>
67+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Versioning.ObsoletedOSPlatformAttribute" /> attribute class for the specified obsoleted OS platform with an additional message.</summary>
6868
<remarks>To be added.</remarks>
6969
</Docs>
7070
</Member>
@@ -84,9 +84,9 @@
8484
<ReturnType>System.String</ReturnType>
8585
</ReturnValue>
8686
<Docs>
87-
<summary>To be added.</summary>
88-
<value>To be added.</value>
89-
<remarks>To be added.</remarks>
87+
<summary>Gets the optional additional message provided for the attribute.</summary>
88+
<value>A string that represents the message, or <see langword="null"/> if there is none.</value>
89+
<remarks>Provides additional information about the obsoleted API, often to suggest a better alternative to use on the specified OS platform.</remarks>
9090
</Docs>
9191
</Member>
9292
<Member MemberName="Url">
@@ -105,8 +105,8 @@
105105
<ReturnType>System.String</ReturnType>
106106
</ReturnValue>
107107
<Docs>
108-
<summary>To be added.</summary>
109-
<value>To be added.</value>
108+
<summary>Gets or sets the URL for corresponding documentation.</summary>
109+
<value>The string that represents a URL to corresponding documentation.</value>
110110
<remarks>To be added.</remarks>
111111
</Docs>
112112
</Member>

0 commit comments

Comments
 (0)