From 828be405e11dd8bc7f8a3692d2c74517734f67a5 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 30 Aug 2020 22:53:19 -0400 Subject: use inheritdoc --- src/SMAPI/Framework/Networking/MultiplayerPeer.cs | 18 ++++++++---------- src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs | 6 +++--- 2 files changed, 11 insertions(+), 13 deletions(-) (limited to 'src/SMAPI/Framework/Networking') diff --git a/src/SMAPI/Framework/Networking/MultiplayerPeer.cs b/src/SMAPI/Framework/Networking/MultiplayerPeer.cs index 6b45b04a..5eda71f6 100644 --- a/src/SMAPI/Framework/Networking/MultiplayerPeer.cs +++ b/src/SMAPI/Framework/Networking/MultiplayerPeer.cs @@ -18,25 +18,25 @@ namespace StardewModdingAPI.Framework.Networking /********* ** Accessors *********/ - /// The player's unique ID. + /// public long PlayerID { get; } - /// Whether this is a connection to the host player. + /// public bool IsHost { get; } - /// Whether the player has SMAPI installed. + /// public bool HasSmapi => this.ApiVersion != null; - /// The player's OS platform, if is true. + /// public GamePlatform? Platform { get; } - /// The installed version of Stardew Valley, if is true. + /// public ISemanticVersion GameVersion { get; } - /// The installed version of SMAPI, if is true. + /// public ISemanticVersion ApiVersion { get; } - /// The installed mods, if is true. + /// public IEnumerable Mods { get; } @@ -62,9 +62,7 @@ namespace StardewModdingAPI.Framework.Networking this.SendMessageImpl = sendMessage; } - /// Get metadata for a mod installed by the player. - /// The unique mod ID. - /// Returns the mod info, or null if the player doesn't have that mod. + /// public IMultiplayerPeerMod GetMod(string id) { if (string.IsNullOrWhiteSpace(id) || this.Mods == null || !this.Mods.Any()) diff --git a/src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs b/src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs index 1b324bcd..8087dc7e 100644 --- a/src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs +++ b/src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs @@ -5,13 +5,13 @@ namespace StardewModdingAPI.Framework.Networking /********* ** Accessors *********/ - /// The mod's display name. + /// public string Name { get; } - /// The unique mod ID. + /// public string ID { get; } - /// The mod version. + /// public ISemanticVersion Version { get; } -- cgit