Constants

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

Summary
Constants that are used throughout the script.
Constants representing all the types of Natural Docs sections.
Returns whether the topic is a list topic.
Returns what type the list topic is a list of.
Constants representing all the types of sections that can appear in the menu file.

Topic Types

Constants representing all the types of Natural Docs sections. 

TOPIC_CLASSA class.  All topics until the next class or section become its members. 
TOPIC_SECTIONA main section of code or text.  Formats like a class but doesn’t provide scope.  Also ends the scope of a class. 
TOPIC_FILEA file.  Is always referenced as a global, but does not end a class scope. 
TOPIC_GROUPA subdivider for long lists. 
TOPIC_FUNCTIONA function.  The code immediately afterwards will be used as the prototype if it matches the name. 
TOPIC_VARIABLEA variable.  The code immediately afterwards will be used as the prototype if it matches the name. 
TOPIC_GENERICA generic topic. 
TOPIC_CLASS_LISTA list of classes where it’s not worth giving each its own entry.  Will not have scope. 
TOPIC_FILE_LISTA list of files where it’s not worth giving each its own entry. 
TOPIC_FUNCTION_LISTA list of functions where it’s not worth giving each its own entry.  Will not have prototypes. 
TOPIC_VARIABLE_LISTA list of variables where it’s not worth giving each its own entry.  Will not have prototypes. 
TOPIC_GENERIC_LISTA list of generic topics where it’s not worth giving each its own entry, such as constants. 

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 Item Types

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

MENU_TITLEThe title of the menu. 
MENU_SUBTITLEThe sub-title of the menu. 
MENU_FILEA source file, relative to the source directory. 
MENU_GROUPA group. 
MENU_TEXTArbitrary text. 
MENU_LINKA web link. 
MENU_FOOTERFooter text. 
MENU_INDEXAn index. 

File Status Constants

FILE_NEWThe file has been added since the last run. 
FILE_CHANGEDThe file has been modified since the last run. 
FILE_SAMEThe file hasn’t been modified since the last run. 
FILE_DOESNTEXISTThe file doesn’t exist, or was deleted.