Format and syntax

Some text

Basic block to show text.

`content`

Useful to highlight arguments of a function. Note: it doesn't support complex code block with a language (like ```lua ```).

[label](https://)

You can add URL link with a label. URL must starts with https://.

• - Item A

• - Item B

1. 1. Item 1

2. 2. Item 2

• [ ] Item T

• [x] Item D

You can add ordered lists, unordered lists and tasks lists. In all cases, they will be visible as unordered lists using - as a prefix.

Note: you must not add newlines per item. It is not supported for now and formatting will not work as expected in NativeDB.

Markdown example will look like this: - Item A - Item B - Item 1 - Item 2 - Item T - Item D

**bold**

*italic*

# H1 ## H2 ### H3

{% hint %} {% endhint %}

[ClassName]

Write the native name / alias name of a class between brackets ([]). NativeDB will automatically format it as a link to navigate to the class.

[this.prop] [ClassName.prop]

When documenting a class, you can reference its own properties using this. followed by the name of the property.

You can also reference properties of other classes using ClassName. instead of this..

It must be surrounded by brackets ([]) in both cases.

[this.GetStuff] [ClassName.SetStuff]

When documenting a class, you can reference its own functions using this. followed by the name of the function. You can also reference functions of other classes using ClassName. instead of this.. It must be surrounded by brackets ([]) in both cases.

[Enum.Value] [Bitfield.Value]

You can reference value of an enum and value of a bitfield.