Skip to content

Automatic port of *OSPlatformAttribute docs #4883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 22, 2020
Merged

Automatic port of *OSPlatformAttribute docs #4883

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b235a4d
Automatic port of *OSPlatformAttribute docs
carlossanlop Sep 21, 2020
8afe645
Missing TargetPlatformAttribute constructor parameter description.
carlossanlop Sep 21, 2020
db75693
Apply suggestions from code review
carlossanlop Sep 21, 2020
020a216
Update xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml
carlossanlop Sep 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,17 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Records the operating system (and minimum version) that supports an API. Multiple attributes can be applied to indicate support on multiple operating systems.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Callers can apply a <xref:System.Runtime.Versioning.SupportedOSPlatformAttribute> or use guards to prevent calls to APIs on unsupported operating systems.
A given platform should only be specified once.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -40,8 +49,8 @@
<Parameter Name="platformName" Type="System.String" />
</Parameters>
<Docs>
<param name="platformName">To be added.</param>
<summary>To be added.</summary>
<param name="platformName">The supported OS platform name.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.SupportedOSPlatformAttribute" /> attribute class for the specified supported OS platform.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Runtime.Versioning/TargetPlatformAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
<Parameter Name="platformName" Type="System.String" />
</Parameters>
<Docs>
<param name="platformName">To be added.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Versioning.TargetPlatformAttribute" /> class.</summary>
<param name="platformName">The target OS platform name.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Versioning.TargetPlatformAttribute" /> attribute class for the specified target OS platform.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
16 changes: 12 additions & 4 deletions xml/System.Runtime.Versioning/UnsupportedOSPlatformAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,16 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Marks APIs that were removed in a given operating system version.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Primarily used by OS bindings to indicate APIs that are only available in earlier versions.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -40,8 +48,8 @@
<Parameter Name="platformName" Type="System.String" />
</Parameters>
<Docs>
<param name="platformName">To be added.</param>
<summary>To be added.</summary>
<param name="platformName">The unsupported OS platform name.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute" /> attribute class for the specified unsupported OS platform.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down