Natural Docs
Natural Docs Keywords

Keywords are not case sensitive.  See the syntax page for an explanation of what each group does.


Section
Section
Title
Group
Group
Class
Singulars of >
Class
Structure
Struct
Package
Class Lists
< Plurals of
Classes
Structures
Structs
Packages

Classes documented as lists cannot have documented members.
Function
Singulars of >
Function
Func
Procedure
Proc
Routine
Subroutine
Sub
Method
Callback
Function Lists
< Plurals of
Functions
Funcs
Procedures
Procs
Routines
Subroutines
Subs
Methods
Callbacks

Functions documented as lists will not have prototypes included in the documentation
Variable
Singulars of >
Variable
Var
Integer
Int
Float
Long
Double
Scalar
Array
ArrayRef
Hash
HashRef
Boolean
Bool
Flag
Bit
BitField
Field
Pointer
Ptr
Reference
Ref
Object
Obj
Character
Char
String
Str
Handle

Indexed as properties:
Property
Prop
Variable Lists
< Plurals of
Variables
Vars
Integers
Ints
Floats
Longs
Doubles
Scalars
Arrays
ArrayRefs
Hashes
HashRefs
Booleans
Bools
Flags
Bits
BitFields
Fields
Pointers
Ptrs
References
Refs
Objects
Objs
Characters
Chars
Strings
Strs
Handles

Indexed as properties:
Properties
Props

Variables documented as lists will not have prototypes included in the documentation
Generic
Topic
About
Note

Singulars of >
Item
Option
Symbol
Sym
Definition
Define
Def
Macro
Format

Indexed as types:
Type
TypeDef

Indexed as constants:
Constant
Const
Generic Lists
List



< Plurals of
Items
Options
Symbols
Syms
Definitions
Defines
Defs
Macros
Formats

Indexed as types:
Types
TypeDefs

Indexed as constants:
Constants
Consts
Enumeration
Enum
File
Singulars of >
File
Program
Script
Module
Document
Doc
Header
File Lists
< Plurals of
Files
Programs
Scripts
Modules
Documents
Docs
Headers