gaemstone/src/gaemstone/Doc+Attributes.cs

using System;

namespace gaemstone;

public partial class Doc
{
	/// <summary>
	/// A display name for this entity.
	/// Names in the entity hierarchy must be unique within the parent entity,
	/// This doesn't apply to display names - they are mostly informational.
	/// Displayed in the Entity Inspector.
	/// </summary>
	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum)]
	public class NameAttribute : Attribute
	{
		public string Value { get; }
		public NameAttribute(string value) => Value = value;
	}

	/// <summary>
	/// A brief description of this entity.
	/// Displayed in the Entity Inspector.
	/// </summary>
	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum)]
	public class BriefAttribute : Attribute
	{
		public string Value { get; }
		public BriefAttribute(string value) => Value = value;
	}

	/// <summary>
	/// A detailed description, or full documentation, of this entity's purpose and behaviors.
	/// It's encouraged to use multiple paragraphs and markdown formatting if necessary.
	/// Displayed in the Entity Inspector.
	/// </summary>
	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum)]
	public class DetailAttribute : Attribute
	{
		public string Value { get; }
		public DetailAttribute(string value) => Value = value;
	}

	/// <summary>
	/// A link to a website relating to this entity, such as
	/// a module's repository, or further documentation.
	/// Displayed in the Entity Inspector.
	/// </summary>
	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum)]
	public class LinkAttribute : Attribute
	{
		public string Value { get; }
		public LinkAttribute(string value) => Value = value;
	}

	/// <summary>
	/// A custom color to represent this entity.
	/// Displayed in the Entity Inspector.
	/// </summary>
	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum)]
	public class ColorAttribute : Attribute
	{
		// TODO: Should we be passing a string?
		public string Value { get; }
		public ColorAttribute(string value) => Value = value;
	}
}