summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/Networking
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-08-30 22:53:19 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-08-30 22:53:19 -0400
commit828be405e11dd8bc7f8a3692d2c74517734f67a5 (patch)
tree0a85e065e7b5604b4c1d0a1b24a53a9f85f550e5 /src/SMAPI/Framework/Networking
parent3a4606164c6ce8d900077b567dc1142f6aad0f4c (diff)
downloadSMAPI-828be405e11dd8bc7f8a3692d2c74517734f67a5.tar.gz
SMAPI-828be405e11dd8bc7f8a3692d2c74517734f67a5.tar.bz2
SMAPI-828be405e11dd8bc7f8a3692d2c74517734f67a5.zip
use inheritdoc
Diffstat (limited to 'src/SMAPI/Framework/Networking')
-rw-r--r--src/SMAPI/Framework/Networking/MultiplayerPeer.cs18
-rw-r--r--src/SMAPI/Framework/Networking/MultiplayerPeerMod.cs6
2 files changed, 11 insertions, 13 deletions
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
*********/
- /// <summary>The player's unique ID.</summary>
+ /// <inheritdoc />
public long PlayerID { get; }
- /// <summary>Whether this is a connection to the host player.</summary>
+ /// <inheritdoc />
public bool IsHost { get; }
- /// <summary>Whether the player has SMAPI installed.</summary>
+ /// <inheritdoc />
public bool HasSmapi => this.ApiVersion != null;
- /// <summary>The player's OS platform, if <see cref="HasSmapi"/> is true.</summary>
+ /// <inheritdoc />
public GamePlatform? Platform { get; }
- /// <summary>The installed version of Stardew Valley, if <see cref="HasSmapi"/> is true.</summary>
+ /// <inheritdoc />
public ISemanticVersion GameVersion { get; }
- /// <summary>The installed version of SMAPI, if <see cref="HasSmapi"/> is true.</summary>
+ /// <inheritdoc />
public ISemanticVersion ApiVersion { get; }
- /// <summary>The installed mods, if <see cref="HasSmapi"/> is true.</summary>
+ /// <inheritdoc />
public IEnumerable<IMultiplayerPeerMod> Mods { get; }
@@ -62,9 +62,7 @@ namespace StardewModdingAPI.Framework.Networking
this.SendMessageImpl = sendMessage;
}
- /// <summary>Get metadata for a mod installed by the player.</summary>
- /// <param name="id">The unique mod ID.</param>
- /// <returns>Returns the mod info, or <c>null</c> if the player doesn't have that mod.</returns>
+ /// <inheritdoc />
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
*********/
- /// <summary>The mod's display name.</summary>
+ /// <inheritdoc />
public string Name { get; }
- /// <summary>The unique mod ID.</summary>
+ /// <inheritdoc />
public string ID { get; }
- /// <summary>The mod version.</summary>
+ /// <inheritdoc />
public ISemanticVersion Version { get; }