From 89b475661afa615d5e2dfac3ad013e23820cc44e Mon Sep 17 00:00:00 2001 From: YoshiRulz Date: Wed, 1 Jan 2020 08:56:15 +1000 Subject: [PATCH] Improve exception docs in BizHawk.Client.ApiHawk --- .../Attributes/BizHawkExternalToolUsageAttribute.cs | 10 ++++------ BizHawk.Client.ApiHawk/Classes/BasicApiProvider.cs | 7 +++---- BizHawk.Client.ApiHawk/Classes/Joypad.cs | 1 + 3 files changed, 8 insertions(+), 10 deletions(-) diff --git a/BizHawk.Client.ApiHawk/Attributes/BizHawkExternalToolUsageAttribute.cs b/BizHawk.Client.ApiHawk/Attributes/BizHawkExternalToolUsageAttribute.cs index 0c15e79c1a..2f244bf513 100644 --- a/BizHawk.Client.ApiHawk/Attributes/BizHawkExternalToolUsageAttribute.cs +++ b/BizHawk.Client.ApiHawk/Attributes/BizHawkExternalToolUsageAttribute.cs @@ -11,12 +11,10 @@ namespace BizHawk.Client.ApiHawk { #region cTor(s) - /// - /// Initialize a new instance of - /// - /// i.e. what your external tool is for - /// that your external tool is used for - /// The game hash, unique game ID (see in the game database) + /// + /// is and is , or + /// usage is and is blank + /// public BizHawkExternalToolUsageAttribute(BizHawkExternalToolUsage usage, CoreSystem system, string gameHash) { if (usage == BizHawkExternalToolUsage.EmulatorSpecific && system == CoreSystem.Null) diff --git a/BizHawk.Client.ApiHawk/Classes/BasicApiProvider.cs b/BizHawk.Client.ApiHawk/Classes/BasicApiProvider.cs index 1d35d3cb54..293777e9b8 100644 --- a/BizHawk.Client.ApiHawk/Classes/BasicApiProvider.cs +++ b/BizHawk.Client.ApiHawk/Classes/BasicApiProvider.cs @@ -30,10 +30,9 @@ namespace BizHawk.Client.ApiHawk _apis = libs; } - /// - /// the client can call this to register an additional Api - /// - /// The to register + /// the client can call this to register an additional API + /// the type, inheriting , to be registered + /// is null public void Register(T api) where T : IExternalApi { diff --git a/BizHawk.Client.ApiHawk/Classes/Joypad.cs b/BizHawk.Client.ApiHawk/Classes/Joypad.cs index 927c855803..2e2391190b 100644 --- a/BizHawk.Client.ApiHawk/Classes/Joypad.cs +++ b/BizHawk.Client.ApiHawk/Classes/Joypad.cs @@ -25,6 +25,7 @@ namespace BizHawk.Client.ApiHawk /// /// What this is used for /// Which player this controller is assigned to + /// not in range 1..max where max is . internal Joypad(SystemInfo system, int player) { if (player < 1 || player > system.MaxControllers)