03. Document Properties

Properties are additional objects attached to a document (Class, Field, Method, etc.). With properties, you can change the name/type of method/field, add comments, or assign new types for type conversion (like Special.Item to `Internal.ItemStack_).

Recommended to read with 02. Dynamic Document Modification.

Functional Properties

Functional properties are properties that directly attached to the document and have a certain function on the original document.

property:modify

property:comment

property:assign

property:hide

Type properties

Type properties simply describe a type, for many usages in the document.

type:primitive

Represents a plain string. Will be as-is when formatted.

type:class

Represents a class type. Will be automatically resolved when formatted.

type:array

Represents an array type. Will be InnerType[] when formatted.

type:parameterized

Represents a parameterized type. WIll be BaseType<ParamType1, ...> when formatted.

type:variable

Represents a variable type. Will be as-is when formatted.

type:union

Represents a union type. Will be Type1 | Type2 ... when formatted.

type:intersection

Represents an intersection type. Will be Type1 & Type2 ... when formatted.

type:jsArray

Reprensents a JSDoc array type. Will be [Type1, Type2 ...] when formatted.

type:object

Represents an object type. Will be {key1: Type1, key2: Type2 ...} when formatted.