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/ModHelpers/ModRegistryHelper.cs | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) (limited to 'src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs') diff --git a/src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs b/src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs index f42cb085..ef1ad30c 100644 --- a/src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs @@ -38,28 +38,25 @@ namespace StardewModdingAPI.Framework.ModHelpers this.Monitor = monitor; } - /// Get metadata for all loaded mods. + /// public IEnumerable GetAll() { return this.Registry.GetAll(); } - /// Get metadata for a loaded mod. - /// The mod's unique ID. - /// Returns the matching mod's metadata, or null if not found. + /// public IModInfo Get(string uniqueID) { return this.Registry.Get(uniqueID); } - /// Get whether a mod has been loaded. - /// The mod's unique ID. + /// public bool IsLoaded(string uniqueID) { return this.Registry.Get(uniqueID) != null; } - /// Get the API provided by a mod, or null if it has none. This signature requires using the API to access the API's properties and methods. + /// public object GetApi(string uniqueID) { // validate ready @@ -76,9 +73,7 @@ namespace StardewModdingAPI.Framework.ModHelpers return mod?.Api; } - /// Get the API provided by a mod, mapped to a given interface which specifies the expected properties and methods. If the mod has no API or it's not compatible with the given interface, get null. - /// The interface which matches the properties and methods you intend to access. - /// The mod's unique ID. + /// public TInterface GetApi(string uniqueID) where TInterface : class { // get raw API -- cgit