diff options
author | Raul Santos <raulsntos@gmail.com> | 2022-08-24 13:56:46 +0200 |
---|---|---|
committer | Raul Santos <raulsntos@gmail.com> | 2022-08-25 17:09:32 +0200 |
commit | f8ceceed15a76e23738dfe96abd852b5d05d7b20 (patch) | |
tree | de902787d1c04329b4d67f373133d8b1d794ff48 /modules/mono/editor | |
parent | 0cf0e960387620e6a206b5417b25aca008788043 (diff) |
Various C# documentation improvements
Fixes wrong/invalid documentation and add documentation to some OS members.
Diffstat (limited to 'modules/mono/editor')
-rw-r--r-- | modules/mono/editor/GodotTools/GodotTools/Utils/OS.cs | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/modules/mono/editor/GodotTools/GodotTools/Utils/OS.cs b/modules/mono/editor/GodotTools/GodotTools/Utils/OS.cs index 76f0f0b784..651922d019 100644 --- a/modules/mono/editor/GodotTools/GodotTools/Utils/OS.cs +++ b/modules/mono/editor/GodotTools/GodotTools/Utils/OS.cs @@ -15,6 +15,9 @@ namespace GodotTools.Utils [SuppressMessage("ReSharper", "InconsistentNaming")] public static class OS { + /// <summary> + /// Display names for the OS platforms. + /// </summary> private static class Names { public const string Windows = "Windows"; @@ -30,6 +33,9 @@ namespace GodotTools.Utils public const string HTML5 = "HTML5"; } + /// <summary> + /// Godot platform identifiers. + /// </summary> public static class Platforms { public const string Windows = "windows"; @@ -42,6 +48,10 @@ namespace GodotTools.Utils public const string HTML5 = "javascript"; } + /// <summary> + /// OS name part of the .NET runtime identifier (RID). + /// See https://docs.microsoft.com/en-us/dotnet/core/rid-catalog. + /// </summary> public static class DotNetOS { public const string Win = "win"; |