Codex Documentation Manager

Usage

The field component is used to describe a typed or non-typed field of an object. This can be used for class definitions, interchange format documentation such as YAML or JSON, or other similar uses.

Properties

name

required

String

The name of the field

type

optional

String

The type name of the field. This can be omitted if not applicable.

type_link

optional

String

If present the type will be converted into a link to the url specified here.

deprecated

optional

Bool

If true the field will be marked with a deprecation warning and badge.

Example

<Field 
    name="type" 
    type="String" 
    type_link="https://en.wikipedia.org/wiki/String_(computer_science)">
The type name of the field. This can be omitted if not applicable.
</Field>

basic_field

optional

String

Here is an example field with a type link

<Field 
    name="type" 
    type="String" 
    deprecated="true">
    Here is an example field that has been deprecated.
</Field>

deprecated_field

deprecated optional

String

Here is an example field that has been deprecated.

This field is has been deprecated and will be removed in a future version.