8000 Automatic port of System.OperatingSystem docs for RC2 by carlossanlop · Pull Request #4852 · dotnet/dotnet-api-docs · GitHub
[go: up one dir, main page]
Skip to content

Automatic port of System.OperatingSystem docs for RC2 #4852

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 1 commit into from
Sep 15, 2020
Merged

Automatic port of System.OperatingSystem docs for RC2 #4852

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8000
Diff view
149 changes: 83 additions & 66 deletions xml/System/OperatingSystem.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,8 +270,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running on Android.</summary>
<returns>
<see langword="true" /> if the current application is running on Android; <see langword="false" /> otherwise.</returns>
< 8000 span class='blob-code-inner blob-code-marker ' data-code-marker=" "> <remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -302,12 +303,13 @@
<Parameter Name="revision" Type="System.Int32" Index="3" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="major">To be added.</param>
<param name="minor">To be added.</param>
<param name="build">To be added.</param>
<param name="revision">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="major">The major release number.</param>
<param name="minor">The minor release number.</param>
<param name="build">The build release number.</param>
<param name="revision">The revision release number.</param>
<summary>Check for the Android version (returned by <code>uname</code>) with a &gt;= version comparison. This is used to guard APIs that were added in the given Android release.</summary>
<returns>
<see langword="true" /> if the current application is running on an Android version that is at least what was specified in the parameters; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -334,8 +336,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running as WASM in a browser.</summary>
<returns><see langword="true" /> if the current application is running as WASM in a browser; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -362,8 +364,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running on FreeBSD.</summary>
<returns>
<see langword="true" /> if the current a 8000 pplication is running on FreeBSD; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -394,12 +397,13 @@
<Parameter Name="revision" Type="System.Int32" Index="3" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="major">To be added.</param>
<param name="minor">To be added.</param>
<param name="build">To be added.</param>
<param name="revision">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="major">The major release number.</param>
<param name="minor">The minor release number.</param>
<param name="build">The build release number.</param>
<param name="revision">The revision release number.</param>
<summary>Check for the FreeBSD version (returned by <code>uname</code>) with a &gt;= version comparison. This is used to guard APIs that were added in the given FreeBSD release.</summary>
<returns>
<see langword="true" /> if the current application is running on a FreeBSD version that is at least what was specified in the parameters; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -426,8 +430,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running on iOS.</summary>
<returns>
<see langword="true" /> if the current application is running on iOS; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -457,11 +462,12 @@
<Parameter Name="build" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="major">To be added.</param>
<param name="minor">To be added.</param>
<param name="build">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="major">The major release number.</param>
<param name="minor">The minor release number.</param>
<param name="build">The build release number.</param>
<summary>Check for the iOS version (returned by <code>libobjc.get_operatingSystemVersion</code>) with a &gt;= version comparison. This is used to guard APIs that were added in the given iOS release.</summary>
<returns>
<see langword="true" /> if the current application is running on an iOS version that is at least what was specified in the parameters; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -488,8 +494,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running on Linux.</summary>
<returns>
<see langword="true" /> if the current application is running on Linux; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -516,8 +523,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running on macOS.</summary>
<returns>
<see langword="true" /> if the current application is running on macOS; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -547,11 +555,12 @@
<Parameter Name="build" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="major">To be added.</param>
<param name="minor">To be added.</param>
<param name="build">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="major">The major release number.</param>
<param name="minor">The minor release number.</param>
<param name="build">The build release number.</param>
<summary>Check for the macOS version (returned by <code>libobjc.get_operatingSystemVersion</code>) with a &gt;= version comparison. This is used to guard APIs that were added in the given macOS release.</summary>
<returns>
<see langword="true" /> if the current application is running on an macOS version that is at least what was specified in the parameters; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -580,9 +589,10 @@
<Parameter Name="platform" Type="System.String" Index="0" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="platform">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="platform">The case-insensitive platform name. Examples: Browser, Linux, FreeBSD, Android, iOS, macOS, tvOS, watchOS, Windows.</param>
<summary>Indicates whether the current application is running on the specified platform.</summary>
<returns>
<see langword="true" /> if the current application is running on the specified platform; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -614,13 +624,14 @@
<Parameter Name="revision" Type="System.Int32" Index="4" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="platform">To be added.</param>
<param name="major">To be added.</param>
<param name="minor">To be added.</param>
<param name="build">To be added.</param>
<param name="revision">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="platform">The case-insensitive platform name. Examples: Browser, Linux, FreeBSD, Android, iOS, macOS, tvOS, watchOS, Windows.</param>
<param name="major">The major release number.</param>
<param name="minor">The minor release number (optional).</param>
<param name="build">The build release number (optional).</param>
<param name="revision">The revision release number (optional).</param>
<summary>Check for the OS with a &gt;= version comparison. This is used to guard APIs that were added in the given OS release.</summary>
<returns>
<see langword="true" /> if the current application is running on the specified platform and is at least in the version specified in the parameters; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -647,8 +658,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running on tvOS.</summary>
<returns>
<see langword="true" /> if the current application is running on tvOS; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -678,11 +690,12 @@
<Parameter Name="build" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="major">To be added.</param>
<param name="minor">To be added.</param>
<param name="build">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="major">The major release number.</param>
<param name="minor">The minor release number.</param>
<param name="build">The build release number.</param>
<summary>Check for the tvOS version (returned by <code>libobjc.get_operatingSystemVersion</code>) with a &gt;= version comparison. This is used to guard APIs that were added in the given tvOS release.</summary>
<returns>
<see langword="true" /> if the current application is running on a tvOS version that is at least what was specified in the parameters; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -709,8 +722,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running on watchOS.</summary>
<returns>
<see langword="true" /> if the current application is running on watchOS; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -740,11 +754,12 @@
<Parameter Name="build" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="major">To be added.</param>
<param name="minor">To be added.</param>
<param name="build">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="major">The major release number.</param>
<param name="minor">The minor release number.</param>
<param name="build">The build release number.</param>
<summary>Check for the watchOS version (returned by <code>libobjc.get_operatingSystemVersion</code>) with a &gt;= version comparison. This is used to guard APIs that were added in the given watchOS release.</summary>
<returns>
<see langword="true" /> if the current application is running on a watchOS version that is at least what was specified in the parameters; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -771,8 +786,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Indicates whether the current application is running on Windows.</summary>
<returns>
<see langword="true" /> if the current application is running on Windows; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -803,12 +819,13 @@
<Parameter Name="revision" Type="System.Int32" Index="3" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="major">To be added.</param>
<param name="minor">To be added.</param>
<param name="build">To be added.</param>
<param name="revision">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="major">The major release number.</param>
<param name="minor">The minor release number.</param>
<param name="build">The build release number.</param>
<param name="revision">The revision release number.</param>
<summary>Check for the Windows version (returned by <code>RtlGetVersion</code>) with a &gt;= version comparison. This is used to guard APIs that were added in the given Windows release.</summary>
<returns>
<see langword="true" /> if the current application is running on a Windows version that is at least what was specified in the parameters; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
0