NaturalDocs:: Constants	Constants that are used throughout the script.
Assumptions	No constant here will ever be zero.
Topic Types	Constants representing all the types of Natural Docs sections.
TopicIsList	Returns whether the topic is a list topic.
TopicIsListOf	Returns what type the list topic is a list of.
Menu Entry Types	Constants representing all the types of sections that can appear in the menu file.
Menu Entry Flags	The various flags that can apply to a menu entry.
File Status Constants
BINARY_FORMAT	An 8-bit constant that’s used as the first byte of binary data files.

Assumptions

No constant here will ever be zero.

Topic Types

Constants representing all the types of Natural Docs sections.

TOPIC_CLASS	A class. All topics until the next class or section become its members.
TOPIC_SECTION	A main section of code or text. Formats like a class but doesn’t provide scope. Also ends the scope of a class.
TOPIC_FILE	A file. Is always referenced as a global, but does not end a class scope.
TOPIC_GROUP	A subdivider for long lists.
TOPIC_FUNCTION	A function. The code immediately afterwards will be used as the prototype if it matches the name.
TOPIC_VARIABLE	A variable. The code immediately afterwards will be used as the prototype if it matches the name.
TOPIC_GENERIC	A generic topic.
TOPIC_CLASS_LIST	A list of classes where it’s not worth giving each its own entry. Will not have scope.
TOPIC_FILE_LIST	A list of files where it’s not worth giving each its own entry.
TOPIC_FUNCTION_LIST	A list of functions where it’s not worth giving each its own entry. Will not have prototypes.
TOPIC_VARIABLE_LIST	A list of variables where it’s not worth giving each its own entry. Will not have prototypes.
TOPIC_GENERIC_LIST	A list of generic topics where it’s not worth giving each its own entry, such as constants.

Dependency

NaturalDocs.m depends on these values all being able to fint into a UInt8, i.e. <= 255.

TopicIsList

sub TopicIsList #

(

topic

)

Returns whether the topic is a list topic.

TopicIsListOf

sub TopicIsListOf #

(

topic

)

Returns what type the list topic is a list of. Assumes the topic is a list topic.

Menu Entry Types

Constants representing all the types of sections that can appear in the menu file.

MENU_TITLE	The title of the menu.
MENU_SUBTITLE	The sub-title of the menu.
MENU_FILE	A source file, relative to the source directory.
MENU_GROUP	A group.
MENU_TEXT	Arbitrary text.
MENU_LINK	A web link.
MENU_FOOTER	Footer text.
MENU_INDEX	An index.
MENU_FORMAT	The version of Natural Docs the menu file was generated with.
MENU_ENDOFORIGINAL	A dummy entry that marks where the original group content ends. This is used when automatically changing the groups so that the alphabetization or lack thereof can be detected without being affected by new entries tacked on to the end.

Dependency

NaturalDocs.m depends on these values all being able to fit into a UInt8, i.e. <= 255.

Menu Entry Flags

The various flags that can apply to a menu entry. You cannot mix flags of different types, since they may overlap.

File Flags

MENU_FILE_NOAUTOTITLE

Whether the file is auto-titled or not.

Group Flags

MENU_GROUP_UPDATETITLES	The group should have its auto-titles regenerated.
MENU_GROUP_UPDATESTRUCTURE	The group should be checked for structural changes, such as being removed or being split into subgroups.
MENU_GROUP_UPDATEORDER	The group should be resorted.
MENU_GROUP_HASENDOFORIGINAL	Whether the group contains a dummy MENU_ENDOFORIGINAL entry.
MENU_GROUP_UNSORTED	The group’s contents are not sorted.
MENU_GROUP_FILESSORTED	The group’s files are sorted alphabetically.
MENU_GROUP_FILESANDGROUPSSORTED	The group’s files and sub-groups are sorted alphabetically.
MENU_GROUP_EVERYTHINGSORTED	All entries in the group are sorted alphabetically.

File Status Constants

FILE_NEW	The file has been added since the last run.
FILE_CHANGED	The file has been modified since the last run.
FILE_SAME	The file hasn’t been modified since the last run.
FILE_DOESNTEXIST	The file doesn’t exist, or was deleted.

BINARY_FORMAT

An 8-bit constant that’s used as the first byte of binary data files. This is used so that you can easily distinguish between binary and old-style text data files. It’s not a character that would appear in plain text files.