Constants

Constants that are used throughout the script. All are exported by default.

Summary

Constants	Constants that are used throughout the script.
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 Item Types	Constants representing all the types of sections that can appear in the menu file.
File Status Constants

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.

sub TopicIsList #(topic)

Returns whether the topic is a list topic.

sub TopicIsListOf #(topic)

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

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.

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.