1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-11-24 21:48:35 +01:00

improve documentation links for MlemPlatform

This commit is contained in:
Ell 2024-08-28 13:40:31 +02:00
parent 78c4a74f4b
commit 494a7ebdfe

View file

@ -9,7 +9,7 @@ using MLEM.Formatting.Codes;
namespace MLEM.Misc { namespace MLEM.Misc {
/// <summary> /// <summary>
/// MlemPlatform is a wrapper around some of MonoGame's platform-dependent behavior to allow for MLEM to stay platform-independent. /// MlemPlatform is a wrapper around some of MonoGame's platform-dependent behavior to allow for MLEM to stay platform-independent.
/// See <see cref="DesktopGl{T}"/>, <see cref="DesktopFna"/>, <see cref="Mobile"/> and <see cref="None"/> for information on the specific platforms. /// See <see cref="DesktopGl{T}"/>, <see cref="DesktopFna"/>, <see cref="Mobile"/> and <see cref="None"/>, as well as the online documentation at https://mlem.ellpeck.de/articles/ui.html#text-input for information on the specific platforms.
/// The MLEM demos' main classes also make use of this functionality: https://github.com/Ellpeck/MLEM/blob/main/Demos.DesktopGL/Program.cs#L8 and https://github.com/Ellpeck/MLEM/blob/main/Demos.Android/Activity1.cs#L33. /// The MLEM demos' main classes also make use of this functionality: https://github.com/Ellpeck/MLEM/blob/main/Demos.DesktopGL/Program.cs#L8 and https://github.com/Ellpeck/MLEM/blob/main/Demos.Android/Activity1.cs#L33.
/// </summary> /// </summary>
public abstract class MlemPlatform { public abstract class MlemPlatform {
@ -51,7 +51,7 @@ namespace MLEM.Misc {
/// <exception cref="InvalidOperationException">If <see cref="Current"/> is null</exception> /// <exception cref="InvalidOperationException">If <see cref="Current"/> is null</exception>
public static void EnsureExists() { public static void EnsureExists() {
if (MlemPlatform.Current == null) if (MlemPlatform.Current == null)
throw new InvalidOperationException("MlemPlatform was not initialized. For more information, see the MlemPlatform class or https://mlem.ellpeck.de/api/MLEM.Misc.MlemPlatform"); throw new InvalidOperationException("MlemPlatform was not initialized. For more information, see the MlemPlatform documentation at https://mlem.ellpeck.de/api/MLEM.Misc.MlemPlatform or https://mlem.ellpeck.de/articles/ui.html#text-input");
} }
/// <summary> /// <summary>