Skip to content

Commit 892090f

Browse files
carlossanlopgewarren
carlossanlop
authored and
gewarren
committed
Automatic port of System.OperatingSystem docs for RC2 (dotnet#4852)
Co-authored-by: carlossanlop <[email protected]>
1 parent 7d68494 commit 892090f

File tree

1 file changed

+83
-66
lines changed

1 file changed

+83
-66
lines changed

‎xml/System/OperatingSystem.xml

Lines changed: 83 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,9 @@
270270
</ReturnValue>
271271
<Parameters />
272272
<Docs>
273-
<summary>To be added.</summary>
274-
<returns>To be added.</returns>
273+
<summary>Indicates whether the current application is running on Android.</summary>
274+
<returns>
275+
<see langword="true" /> if the current application is running on Android; <see langword="false" /> otherwise.</returns>
275276
<remarks>To be added.</remarks>
276277
</Docs>
277278
</Member>
@@ -302,12 +303,13 @@
302303
<Parameter Name="revision" Type="System.Int32" Index="3" FrameworkAlternate="net-5.0" />
303304
</Parameters>
304305
<Docs>
305-
<param name="major">To be added.</param>
306-
<param name="minor">To be added.</param>
307-
<param name="build">To be added.</param>
308-
<param name="revision">To be added.</param>
309-
<summary>To be added.</summary>
310-
<returns>To be added.</returns>
306+
<param name="major">The major release number.</param>
307+
<param name="minor">The minor release number.</param>
308+
<param name="build">The build release number.</param>
309+
<param name="revision">The revision release number.</param>
310+
<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>
311+
<returns>
312+
<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>
311313
<remarks>To be added.</remarks>
312314
</Docs>
313315
</Member>
@@ -334,8 +336,8 @@
334336
</ReturnValue>
335337
<Parameters />
336338
<Docs>
337-
<summary>To be added.</summary>
338-
<returns>To be added.</returns>
339+
<summary>Indicates whether the current application is running as WASM in a browser.</summary>
340+
<returns><see langword="true" /> if the current application is running as WASM in a browser; <see langword="false" /> otherwise.</returns>
339341
<remarks>To be added.</remarks>
340342
</Docs>
341343
</Member>
@@ -362,8 +364,9 @@
362364
</ReturnValue>
363365
<Parameters />
364366
<Docs>
365-
<summary>To be added.</summary>
366-
<returns>To be added.</returns>
367+
<summary>Indicates whether the current application is running on FreeBSD.</summary>
368+
<returns>
369+
<see langword="true" /> if the current application is running on FreeBSD; <see langword="false" /> otherwise.</returns>
367370
<remarks>To be added.</remarks>
368371
</Docs>
369372
</Member>
@@ -394,12 +397,13 @@
394397
<Parameter Name="revision" Type="System.Int32" Index="3" FrameworkAlternate="net-5.0" />
395398
</Parameters>
396399
<Docs>
397-
<param name="major">To be added.</param>
398-
<param name="minor">To be added.</param>
399-
<param name="build">To be added.</param>
400-
<param name="revision">To be added.</param>
401-
<summary>To be added.</summary>
402-
<returns>To be added.</returns>
400+
<param name="major">The major release number.</param>
401+
<param name="minor">The minor release number.</param>
402+
<param name="build">The build release number.</param>
403+
<param name="revision">The revision release number.</param>
404+
<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>
405+
<returns>
406+
<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>
403407
<remarks>To be added.</remarks>
404408
</Docs>
405409
</Member>
@@ -426,8 +430,9 @@
426430
</ReturnValue>
427431
<Parameters />
428432
<Docs>
429-
<summary>To be added.</summary>
430-
<returns>To be added.</returns>
433+
<summary>Indicates whether the current application is running on iOS.</summary>
434+
<returns>
435+
<see langword="true" /> if the current application is running on iOS; <see langword="false" /> otherwise.</returns>
431436
<remarks>To be added.</remarks>
432437
</Docs>
433438
</Member>
@@ -457,11 +462,12 @@
457462
<Parameter Name="build" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
458463
</Parameters>
459464
<Docs>
460-
<param name="major">To be added.</param>
461-
<param name="minor">To be added.</param>
462-
<param name="build">To be added.</param>
463-
<summary>To be added.</summary>
464-
<returns>To be added.</returns>
465+
<param name="major">The major release number.</param>
466+
<param name="minor">The minor release number.</param>
467+
<param name="build">The build release number.</param>
468+
<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>
469+
<returns>
470+
<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>
465471
<remarks>To be added.</remarks>
466472
</Docs>
467473
</Member>
@@ -488,8 +494,9 @@
488494
</ReturnValue>
489495
<Parameters />
490496
<Docs>
491-
<summary>To be added.</summary>
492-
<returns>To be added.</returns>
497+
<summary>Indicates whether the current application is running on Linux.</summary>
498+
<returns>
499+
<see langword="true" /> if the current application is running on Linux; <see langword="false" /> otherwise.</returns>
493500
<remarks>To be added.</remarks>
494501
</Docs>
495502
</Member>
@@ -516,8 +523,9 @@
516523
</ReturnValue>
517524
<Parameters />
518525
<Docs>
519-
<summary>To be added.</summary>
520-
<returns>To be added.</returns>
526+
<summary>Indicates whether the current application is running on macOS.</summary>
527+
<returns>
528+
<see langword="true" /> if the current application is running on macOS; <see langword="false" /> otherwise.</returns>
521529
<remarks>To be added.</remarks>
522530
</Docs>
523531
</Member>
@@ -547,11 +555,12 @@
547555
<Parameter Name="build" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
548556
</Parameters>
549557
<Docs>
550-
<param name="major">To be added.</param>
551-
<param name="minor">To be added.</param>
552-
<param name="build">To be added.</param>
553-
<summary>To be added.</summary>
554-
<returns>To be added.</returns>
558+
<param name="major">The major release number.</param>
559+
<param name="minor">The minor release number.</param>
560+
<param name="build">The build release number.</param>
561+
<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>
562+
<returns>
563+
<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>
555564
<remarks>To be added.</remarks>
556565
</Docs>
557566
</Member>
@@ -580,9 +589,10 @@
580589
<Parameter Name="platform" Type="System.String" Index="0" FrameworkAlternate="net-5.0" />
581590
</Parameters>
582591
<Docs>
583-
<param name="platform">To be added.</param>
584-
<summary>To be added.</summary>
585-
<returns>To be added.</returns>
592+
<param name="platform">The case-insensitive platform name. Examples: Browser, Linux, FreeBSD, Android, iOS, macOS, tvOS, watchOS, Windows.</param>
593+
<summary>Indicates whether the current application is running on the specified platform.</summary>
594+
<returns>
595+
<see langword="true" /> if the current application is running on the specified platform; <see langword="false" /> otherwise.</returns>
586596
<remarks>To be added.</remarks>
587597
</Docs>
588598
</Member>
@@ -614,13 +624,14 @@
614624
<Parameter Name="revision" Type="System.Int32" Index="4" FrameworkAlternate="net-5.0" />
615625
</Parameters>
616626
<Docs>
617-
<param name="platform">To be added.</param>
618-
<param name="major">To be added.</param>
619-
<param name="minor">To be added.</param>
620-
<param name="build">To be added.</param>
621-
<param name="revision">To be added.</param>
622-
<summary>To be added.</summary>
623-
<returns>To be added.</returns>
627+
<param name="platform">The case-insensitive platform name. Examples: Browser, Linux, FreeBSD, Android, iOS, macOS, tvOS, watchOS, Windows.</param>
628+
<param name="major">The major release number.</param>
629+
<param name="minor">The minor release number (optional).</param>
630+
<param name="build">The build release number (optional).</param>
631+
<param name="revision">The revision release number (optional).</param>
632+
<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>
633+
<returns>
634+
<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>
624635
<remarks>To be added.</remarks>
625636
</Docs>
626637
</Member>
@@ -647,8 +658,9 @@
647658
</ReturnValue>
648659
<Parameters />
649660
<Docs>
650-
<summary>To be added.</summary>
651-
<returns>To be added.</returns>
661+
<summary>Indicates whether the current application is running on tvOS.</summary>
662+
<returns>
663+
<see langword="true" /> if the current application is running on tvOS; <see langword="false" /> otherwise.</returns>
652664
<remarks>To be added.</remarks>
653665
</Docs>
654666
</Member>
@@ -678,11 +690,12 @@
678690
<Parameter Name="build" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
679691
</Parameters>
680692
<Docs>
681-
<param name="major">To be added.</param>
682-
<param name="minor">To be added.</param>
683-
<param name="build">To be added.</param>
684-
<summary>To be added.</summary>
685-
<returns>To be added.</returns>
693+
<param name="major">The major release number.</param>
694+
<param name="minor">The minor release number.</param>
695+
<param name="build">The build release number.</param>
696+
<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>
697+
<returns>
698+
<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>
686699
<remarks>To be added.</remarks>
687700
</Docs>
688701
</Member>
@@ -709,8 +722,9 @@
709722
</ReturnValue>
710723
<Parameters />
711724
<Docs>
712-
<summary>To be added.</summary>
713-
<returns>To be added.</returns>
725+
<summary>Indicates whether the current application is running on watchOS.</summary>
726+
<returns>
727+
<see langword="true" /> if the current application is running on watchOS; <see langword="false" /> otherwise.</returns>
714728
<remarks>To be added.</remarks>
715729
</Docs>
716730
</Member>
@@ -740,11 +754,12 @@
740754
<Parameter Name="build" Type="System.Int32" Index="2" FrameworkAlternate="net-5.0" />
741755
</Parameters>
742756
<Docs>
743-
<param name="major">To be added.</param>
744-
<param name="minor">To be added.</param>
745-
<param name="build">To be added.</param>
746-
<summary>To be added.</summary>
747-
<returns>To be added.</returns>
757+
<param name="major">The major release number.</param>
758+
<param name="minor">The minor release number.</param>
759+
<param name="build">The build release number.</param>
760+
<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>
761+
<returns>
762+
<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>
748763
<remarks>To be added.</remarks>
749764
</Docs>
750765
</Member>
@@ -771,8 +786,9 @@
771786
</ReturnValue>
772787
<Parameters />
773788
<Docs>
774-
<summary>To be added.</summary>
775-
<returns>To be added.</returns>
789+
<summary>Indicates whether the current application is running on Windows.</summary>
790+
<returns>
791+
<see langword="true" /> if the current application is running on Windows; <see langword="false" /> otherwise.</returns>
776792
<remarks>To be added.</remarks>
777793
</Docs>
778794
</Member>
@@ -803,12 +819,13 @@
803819
<Parameter Name="revision" Type="System.Int32" Index="3" FrameworkAlternate="net-5.0" />
804820
</Parameters>
805821
<Docs>
806-
<param name="major">To be added.</param>
807-
<param name="minor">To be added.</param>
808-
<param name="build">To be added.</param>
809-
<param name="revision">To be added.</param>
810-
<summary>To be added.</summary>
811-
<returns>To be added.</returns>
822+
<param name="major">The major release number.</param>
823+
<param name="minor">The minor release number.</param>
824+
<param name="build">The build release number.</param>
825+
<param name="revision">The revision release number.</param>
826+
<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>
827+
<returns>
828+
<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>
812829
<remarks>To be added.</remarks>
813830
</Docs>
814831
</Member>

0 commit comments

Comments
 (0)