LuaAttributes.cs

namespace BizHawk.Client.Common
{
	[AttributeUsage(AttributeTargets.Parameter)]
	public sealed class LuaColorParamAttribute : Attribute {}

	[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
	public sealed class LuaDeprecatedMethodAttribute : Attribute {}

	[AttributeUsage(AttributeTargets.Method)]
	public sealed class LuaMethodAttribute : Attribute
	{
		public LuaMethodAttribute(string name, string description)
		{
			Name = name;
			Description = description;
		}

		public string Name { get; }
		public string Description { get; }
	}

	[AttributeUsage(AttributeTargets.Method)]
	public sealed class LuaMethodExampleAttribute : Attribute
	{
		public LuaMethodExampleAttribute(string example)
			=> Example = example.ReplaceLineEndings();

		public string Example { get; }
	}

	[AttributeUsage(AttributeTargets.Class)]
	public sealed class LuaLibraryAttribute : Attribute
	{
		public LuaLibraryAttribute(bool released)
		{
			Released = released;
		}

		public bool Released { get; }
	}

	/// <summary>
	/// Marks table return values that are indexed starting from zero, for documentation purposes only.
	/// </summary>
	[AttributeUsage(AttributeTargets.ReturnValue | AttributeTargets.Parameter)]
	public sealed class LuaZeroIndexedAttribute : Attribute { }

	/// <summary>
	/// Specifies a custom type to be used in LuaCATS annotations, for documentation purposes only.
	/// See <see cref="LuaCatsGenerator.Classes" /> and <see href="https://luals.github.io/wiki/annotations/#documenting-types" /> for possible values.
	/// </summary>
	[AttributeUsage(AttributeTargets.ReturnValue | AttributeTargets.Parameter)]
	public sealed class LuaCatsTypeAttribute(string Type) : Attribute
	{
		public string Type { get; } = Type;
	}
}