Follow attribute class best practices, cleanup docs on attributes

Author: YoshiRulz

BizHawk.BizInvoke/BizExvoker.cs

@@ -122,23 +122,15 @@ public static IImportResolver GetExvoker(object o, ICallingConventionAdapter a)
 		}
 	}
 
-	/// <summary>
-	/// mark an instance method to be exported by BizExvoker
-	/// </summary>
+	/// <summary>Indicates that a method is to be exported by BizExvoker.</summary>
 	[AttributeUsage(AttributeTargets.Method)]
-	public class BizExportAttribute : Attribute
+	public sealed class BizExportAttribute : Attribute
 	{
 		public CallingConvention CallingConvention { get; }
 
-		/// <summary>
-		/// Gets or sets the name of entry point; if not given, the method's name is used
-		/// </summary>
+		/// <remarks>The annotated method's name is used iff <see langword="null"/>.</remarks>
 		public string EntryPoint { get; set; }
 
-		/// <summary>
-		/// Initializes a new instance of the <see cref="BizImportAttribute"/> class. 
-		/// </summary>
-		/// <param name="c">unmanaged calling convention</param>
 		public BizExportAttribute(CallingConvention c)
 		{
 			CallingConvention = c;

BizHawk.BizInvoke/BizInvoker.cs

@@ -537,28 +537,18 @@ private static Type EmitParamterLoad(ILGenerator il, int idx, Type type, FieldIn
 		}
 	}
 
-	/// <summary>
-	/// mark an abstract method to be proxied by BizInvoker
-	/// </summary>
+	/// <summary>Indicates that an abstract method is to be proxied by BizInvoker.</summary>
 	[AttributeUsage(AttributeTargets.Method)]
-	public class BizImportAttribute : Attribute
+	public sealed class BizImportAttribute : Attribute
 	{
 		public CallingConvention CallingConvention { get; }
 
-		/// <summary>
-		/// Gets or sets the name of entry point; if not given, the method's name is used
-		/// </summary>
+		/// <remarks>The annotated method's name is used iff <see langword="null"/>.</remarks>
 		public string EntryPoint { get; set; }
 
-		/// <summary>
-		/// Gets or sets a value indicating whether or not to use a slower interop that supports more argument types
-		/// </summary>
+		/// <summary><see langword="true"/> iff a compatibility interop should be used, which is slower but supports more argument types.</summary>
 		public bool Compatibility { get; set; }
 
-		/// <summary>
-		/// Initializes a new instance of the <see cref="BizImportAttribute"/> class. 
-		/// </summary>
-		/// <param name="c">unmanaged calling convention</param>
 		public BizImportAttribute(CallingConvention c)
 		{
 			CallingConvention = c;

BizHawk.Client.ApiHawk/Classes/ApiInjector.cs

@@ -68,12 +68,12 @@ public static bool IsAvailable(IExternalApiProvider source, Type targetType)
 	}
 
 	[AttributeUsage(AttributeTargets.Property)]
-	public class RequiredApiAttribute : Attribute
+	public sealed class RequiredApiAttribute : Attribute
 	{
 	}
 
 	[AttributeUsage(AttributeTargets.Property)]
-	public class OptionalApiAttribute : Attribute
+	public sealed class OptionalApiAttribute : Attribute
 	{
 	}
 }

BizHawk.Client.Common/Api/ExternalToolAttributes.cs

@@ -96,13 +96,12 @@ public class DuplicateException : Exception {}
 	[AttributeUsage(AttributeTargets.Class)]
 	public sealed class ExternalToolAttribute : Attribute
 	{
-		public readonly string Description;
+		public string Description { get; set; }
 
 		public readonly string Name;
 
-		public ExternalToolAttribute(string name, string description = null)
+		public ExternalToolAttribute(string name)
 		{
-			Description = description;
 			Name = string.IsNullOrWhiteSpace(name) ? Guid.NewGuid().ToString() : name;
 		}
 

BizHawk.Client.Common/BinarySaveStates.cs

@@ -69,7 +69,7 @@ public class BinaryStateLump
 		public static BinaryStateLump BranchUserText { get; private set; }
 
 		[AttributeUsage(AttributeTargets.Property)]
-		private class NameAttribute : Attribute
+		private sealed class NameAttribute : Attribute
 		{
 			public string Name { get; }
 			public string Ext { get; }

BizHawk.Client.Common/config/ConfigPersistAttribute.cs

@@ -2,11 +2,9 @@
 
 namespace BizHawk.Client.Common
 {
-	/// <summary>
-	/// Define if the property has to be persisted in config
-	/// </summary>
+	/// <summary>Indicates that a property is to be saved to config for persistence.</summary>
 	[AttributeUsage(AttributeTargets.Property)]
-	public class ConfigPersistAttribute : Attribute
+	public sealed class ConfigPersistAttribute : Attribute
 	{
 	}
 }

BizHawk.Client.Common/config/RestoreDefaultsAttribute.cs

@@ -2,11 +2,10 @@
 
 namespace BizHawk.Client.Common
 {
-	/// <summary>
-	/// Defines a method to be called when a tool dialog's Restore Defaults method is called
-	/// </summary>
+	/// <summary>Indicates which method of an <see cref="IToolFormAutoConfig"/> is to be called when the generated <c>Restore Defaults</c> menu item is clicked.</summary>
+	/// <remarks>If not present on any instance method, the menu item will do nothing. If present on multiple, the first will be called.</remarks>
 	[AttributeUsage(AttributeTargets.Method)]
-	public class RestoreDefaultsAttribute : Attribute
+	public sealed class RestoreDefaultsAttribute : Attribute
 	{
 	}
 }

BizHawk.Client.Common/lua/LuaAttributes.cs

@@ -3,7 +3,7 @@
 namespace BizHawk.Client.Common
 {
 	[AttributeUsage(AttributeTargets.Method)]
-	public class LuaMethodAttribute : Attribute
+	public sealed class LuaMethodAttribute : Attribute
 	{
 		public LuaMethodAttribute(string name, string description)
 		{
@@ -16,7 +16,7 @@ public LuaMethodAttribute(string name, string description)
 	}
 
 	[AttributeUsage(AttributeTargets.Method)]
-	public class LuaMethodExampleAttribute : Attribute
+	public sealed class LuaMethodExampleAttribute : Attribute
 	{
 		public LuaMethodExampleAttribute(string example)
 		{
@@ -27,7 +27,7 @@ public LuaMethodExampleAttribute(string example)
 	}
 
 	[AttributeUsage(AttributeTargets.Class)]
-	public class LuaLibraryAttribute : Attribute
+	public sealed class LuaLibraryAttribute : Attribute
 	{
 		public LuaLibraryAttribute(bool released)
 		{

BizHawk.Client.Common/movie/import/IMovieImport.cs

@@ -101,7 +101,7 @@ public static ImportResult Error(string errorMsg)
 	}
 
 	[AttributeUsage(AttributeTargets.Class)]
-	public class ImporterForAttribute : Attribute
+	public sealed class ImporterForAttribute : Attribute
 	{
 		public ImporterForAttribute(string emulator, string extension)
 		{

BizHawk.Client.EmuHawk/AVOut/IVideoWriter.cs

@@ -99,7 +99,7 @@ public interface IVideoWriter : IDisposable
 	}
 
 	[AttributeUsage(AttributeTargets.Class)]
-	public class VideoWriterAttribute : Attribute
+	public sealed class VideoWriterAttribute : Attribute
 	{
 		public string ShortName { get; }
 		public string Name { get; }
@@ -114,7 +114,7 @@ public VideoWriterAttribute(string shortName, string name, string description)
 	}
 
 	[AttributeUsage(AttributeTargets.Class)]
-	public class VideoWriterIgnoreAttribute : Attribute
+	public sealed class VideoWriterIgnoreAttribute : Attribute
 	{
 	}