Class AddDocumentationPropertyAttribute

Namespace

Vintagestory.API

Assembly

VintagestoryAPI.dll

Adds a new property in the DocFX JSON documentation. Useful for attribute types which do not store JSON properties as variables. Properties need to be serializable by DocFX, hence why they're all strings. Sorry about that.

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
public class AddDocumentationPropertyAttribute : Attribute

Inheritance

object

Attribute

AddDocumentationPropertyAttribute

Inherited Members

Attribute.Equals(object)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetHashCode()

Attribute.IsDefaultAttribute()

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.Match(object)

Attribute.TypeId

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectHandleExtensions.ToGcHandle(object)

ObjectHandleExtensions.ToIntPtr(object)

Constructors

AddDocumentationPropertyAttribute(string, string, string, string, string, bool)

Adds a new property in the DocFX JSON documentation. Useful for attribute types which do not store JSON properties as variables. Properties need to be serializable by DocFX, hence why they're all strings. Sorry about that.

public AddDocumentationPropertyAttribute(string name, string summary, string typeWithFullNamespace, string requiredStatus, string defaultStatus, bool attribute = false)

Parameters

name string

The name of the property in DocFX.

summary string

The summary of the property in DocFX.

typeWithFullNamespace string

The name of the type, along with its full namespace. e.g. "System.Single" or "VintageStory.API.Common.CompositeShape".

requiredStatus string

The text to put inside the "required" tag in DocFX.

defaultStatus string

The text to put inside the "default" tag in DocFX. Use an empty string for none.

attribute bool