Constant Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 ADD_HIDDEN_BREAKS
 AUTO_TOPICS
B
 Binary Format Flags
 BINARY_FORMAT
 BINARYREF_NORESOLVEFLAGS
 BINARYREF_NOTYPE
 BODY
 BREAK_LISTS
 BUILDER
C
 CACHED_LINES
 CAN_GROUP_WITH
 CHILDREN
 CLASS_HIERARCHY
 CLOSING_SYMBOL
 COMBINED_TYPE
 Constants
 CURRENT_INTERPRETATION
D
 Default TopicTypes
 DEFAULT_MENU_TITLE
 DEFAULT_VALUE
 DEFAULT_VALUE_PREFIX
 DEFINITIONS
 DIRECTORY
E
 ENUM_GLOBAL
 ENUM_UNDER_PARENT
 ENUM_UNDER_TYPE
 EnumValuesType
F
 FILE
 FILE_CHANGED
 FILE_DOESNTEXIST
 FILE_NEW
 FILE_SAME
 FileStatus
 FLAGS
G
 GLOBAL_DEFINITION
H
 HAS_CONTENT
 HEIGHT
I
 IGNORED_PREFIX
 Implementation
 INDEX
 INTERPRETATIONS
 IS_LIST
L
 LAST_MODIFIED
 LINE_NUMBER
 LINEREADER_FILEHANDLE
M
 MADE_EMPTY_SEARCH_RESULTS_PAGE
 MAXFILESINGROUP
 Members
 Menu Entry Flags
 Menu Length Constants
 MENU_DATA
 MENU_ENDOFORIGINAL
 MENU_FILE
 MENU_FILE_LENGTH
 MENU_FILE_NOAUTOTITLE
 MENU_FOOTER
 MENU_FORMAT
 MENU_GROUP
 MENU_GROUP_EVERYTHINGSORTED
 MENU_GROUP_FILESANDGROUPSSORTED
 MENU_GROUP_FILESSORTED
 MENU_GROUP_HASENDOFORIGINAL
 MENU_GROUP_ISINDEXGROUP
 MENU_GROUP_LENGTH
 MENU_GROUP_UNSORTED
 MENU_GROUP_UPDATEORDER
 MENU_GROUP_UPDATESTRUCTURE
 MENU_GROUP_UPDATETITLES
 MENU_INDEX
 MENU_LENGTH_LIMIT
 MENU_LINK
 MENU_LINK_LENGTH
 MENU_SUBTITLE
 MENU_SUBTITLE_LENGTH
 MENU_TEXT
 MENU_TEXT_LENGTH
 MENU_TITLE
 MENU_TITLE_LENGTH
 MenuEntryType
 MINFILESINNEWGROUP
N
 NAME
 NAME_PREFIX
 NDMarkupToHTML Styles
 NDMARKUPTOHTML_GENERAL
 NDMARKUPTOHTML_SUMMARY
 NDMARKUPTOHTML_TOOLTIP
P
 PACKAGE
 PACKAGE_SEPARATOR
 PAGE_TITLE_IF_FIRST
 PARENT_REFERENCES
 PARENTS
 PLURAL_NAME
 PROTOTYPE
R
 REFERENCE_CH_CLASS
 REFERENCE_CH_PARENT
 REFERENCE_COUNT
 REFERENCE_TEXT
 REFERENCES
 ReferenceType
 RESOLVE_ABSOLUTE
 RESOLVE_NOPLURAL
 RESOLVE_NOUSING
 RESOLVE_RELATIVE
 Resolving Flags
Just a synonym for “1” so that setting the flag on StringToHTML() is clearer in the calling code.
An arrayref of NaturalDocs::Parser::ParsedTopics generated automatically from the code.
These flags can be combined to specify the format when using ToBinaryFile() and FromBinaryFile().
An 8-bit constant that’s used as the first byte of binary data files.
Do not include the Resolving Flags.
Do not include the ReferenceType.
The body of the topic, formatted in NDMarkup.
Whether list topics should be broken into individual topics in the output.
The NaturalDocs::Builder::Base-derived object for the target’s output format.
An arrayref of lines already read into memory.
The existence hashref of TopicTypes the type can be grouped with.
An existence hashref of the SymbolStrings of all the children this class has.
Whether the topic is part of the class hierarchy.
The closing symbol character of the scope.
The combined TopicType of the element.
The interpretation currently used as the reference target.
Exported constants of the default TopicTypes, so you don’t have to go through TypeFromName() every time.
The file’s default title in the menu.
The default value expression, if any.
The default value prefix which should be aligned separately, if any.
An existence hashref of all the FileNames which define this class.
The output directory of the target.
Values are always global and thus ‘value’.
Values are under the parent in the hierarchy, putting them on the same level as the enum itself.
Values are under the type in the hierarchy, and thus ‘package.enum.value’.
How enum values are handled in the language.
The FileName the package/symbol is defined in.
The file has been modified since the last run.
The file doesn’t exist, or was deleted.
The file has been added since the last run.
The file hasn’t been modified since the last run.
What happened to a file since Natural Docs’ last execution.
Any Menu Entry Flags that apply.
The FileName which defines the global version of the symbol, which is what is used if a file references the symbol but does not have its own definition.
Whether the file contains Natural Docs content or not.
The image height.
The part of the symbol that was stripped off to make the sortable symbol.
The object is implemented as a blessed arrayref.
Whether the topic is indexed.
A hashref of the possible interpretations of this reference.
Whether the topic is a list.
The integer timestamp of when the file was last modified.
The line number of the change.
The file handle being used to read the file.
Whether the search results page for searches with no results was generated.
The maximum number of file entries that can be present in a group before it becomes a candidate for sub-grouping.
The object is implemented as a blessed arrayref, with the follow constants as indexes.
The various flags that can apply to a menu entry.
Constants used to approximate the lengths of the menu or its groups.
Data not meant for user editing.
A dummy entry that marks where the original group content ends.
A source file, relative to the source directory.
The length of one file entry.
Whether the file is auto-titled or not.
Footer text.
The version of Natural Docs the menu file was generated with.
A group.
All entries in the group are sorted alphabetically.
The group’s files and sub-groups are sorted alphabetically.
The group’s files are sorted alphabetically.
Whether the group contains a dummy MENU_ENDOFORIGINAL entry.
Whether the group is used primarily for MENU_INDEX entries.
The length of one group entry.
The group’s contents are not sorted.
The group should be resorted.
The group should be checked for structural changes, such as being removed or being split into subgroups.
The group should have its auto-titles regenerated.
An index.
The limit of the menu’s length.
A web link.
The length of one link entry.
The sub-title of the menu.
The length of the subtitle.
Arbitrary text.
The length of one text entry.
The title of the menu.
The length of the title.
The types of entries that can appear in the menu.
The minimum number of file entries that must be present in a group before it will be automatically created.
The parameter name.
The parameter name prefix which should be aligned separately, if any.
These are the styles used with NDMarkupToHTML().
General style.
For summaries.
For tooltips.
The package SymbolString of the scope.
The combined package separator symbol of the element.
Whether the topic becomes the page title if it’s first in a file.
A hashref of the parent ReferenceStrings this class has.
An existence hashref of the SymbolStrings of all the parents this class has.
The topic’s plural name.
The prototype, if it exists and is applicable.
A class reference handled by NaturalDocs::ClassHierarchy.
A parent class reference handled by NaturalDocs::ClassHierarchy.
The number of references to the image from the source files.
The reference appears in the text of the documentation.
An existence hashref of the ReferenceStrings in the file.
The type of a reference.
The reference text is always absolute.
The reference text may not be interpreted as a plural, and thus match singular forms as well.
The reference text may not include “using” statements when being resolved.
The reference text is truly relative, rather than Natural Docs’ semi-relative.
Used to influence the method of resolving references in NaturalDocs::SymbolTable.
Close