Natural Docs Version 1.2 | Constant Index AUTO_TOPICS, NaturalDocs::Languages::Advanced An arrayref of NaturalDocs::Parser::ParsedTopics generated automatically from the code. BINARY_FORMAT, NaturalDocs::Constants An 8-bit constant that’s used as the first byte of binary data files. BODY, NaturalDocs::Parser::ParsedTopic The body of the topic, formatted in NDMarkup. BUILDER, NaturalDocs::Settings::BuildTarget The NaturalDocs::Builder::Base-derived object for the target’s output format. CHILDREN, NaturalDocs::ClassHierarchy::Class An existence hashref of children this class has. CLASS The class of the topic, if any. The class of the symbol. The target class, or undef if global. CLOSING_COMMENT_SYMBOLS, NaturalDocs::Languages::Simple An arrayref of symbols that ends a multi-line comment. CURRENT_INTERPRETATION, NaturalDocs::SymbolTable::Reference The interpretation currently used as the reference target. DEFAULT_MENU_TITLE, NaturalDocs::Project::File The file’s default title in the menu. DEFINITIONS An existence hashref of all the files which define this class. An existence hashref of the files that define this reference. A hashref of all the files which define this symbol. DIRECTORY, NaturalDocs::Settings::BuildTarget The output directory of the target. EXTENSIONS, NaturalDocs::Languages::Simple An arrayref of the all-lowercase extensions of the language’s files. The file the class/symbol is defined in. The file the target is defined as. FILE_CHANGED, NaturalDocs::Constants The file has been modified since the last run. FILE_DOESNTEXIST, NaturalDocs::Constants The file doesn’t exist, or was deleted. FILE_NEW, NaturalDocs::Constants The file has been added since the last run. FILE_SAME, NaturalDocs::Constants The file hasn’t been modified since the last run. FLAGS, NaturalDocs::Menu::Entry Any Menu Entry Flags that apply. FUNCTION_ENDERS, NaturalDocs::Languages::Simple An arrayref of symbols that can end a function prototype. GLOBAL_DEFINITION, NaturalDocs::SymbolTable::Symbol The name of the file 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. INTERPRETATIONS, NaturalDocs::SymbolTable::Reference A hashref of the possible interpretations of this reference. LAST_MODIFIED, NaturalDocs::Project::File The integer timestamp of when the file was last modified. LINE_COMMENT_SYMBOLS, NaturalDocs::Languages::Simple An arrayref of symbols that start a single line comment. LINE_EXTENDER, NaturalDocs::Languages::Simple The symbol to extend a line of code past a line break. The line number of the change. The line number the topic appears at in the file. MAXFILESINGROUP, NaturalDocs::Menu The maximum number of file entries that can be present in a group before it becomes a candidate for sub-grouping. MENU_DATA, NaturalDocs::Constants Data not meant for user editing. MENU_ENDOFORIGINAL, NaturalDocs::Constants A dummy entry that marks where the original group content ends. MENU_FILE, NaturalDocs::Constants A source file, relative to the source directory. MENU_FILE_NOAUTOTITLE, NaturalDocs::Constants Whether the file is auto-titled or not. MENU_FILELENGTH, NaturalDocs::Builder::HTMLBase The length of one file entry. MENU_FOOTER, NaturalDocs::Constants Footer text. MENU_FORMAT, NaturalDocs::Constants The version of Natural Docs the menu file was generated with. MENU_GROUP, NaturalDocs::Constants A group. MENU_GROUP_EVERYTHINGSORTED, NaturalDocs::Constants All entries in the group are sorted alphabetically. MENU_GROUP_FILESANDGROUPSSORTED, NaturalDocs::Constants The group’s files and sub-groups are sorted alphabetically. MENU_GROUP_FILESSORTED, NaturalDocs::Constants The group’s files are sorted alphabetically. MENU_GROUP_HASENDOFORIGINAL, NaturalDocs::Constants Whether the group contains a dummy MENU_ENDOFORIGINAL entry. MENU_GROUP_ISINDEXGROUP, NaturalDocs::Constants Whether the group is used primarily for MENU_INDEX entries. MENU_GROUP_UNSORTED, NaturalDocs::Constants The group’s contents are not sorted. MENU_GROUP_UPDATEORDER, NaturalDocs::Constants The group should be resorted. MENU_GROUP_UPDATESTRUCTURE, NaturalDocs::Constants The group should be checked for structural changes, such as being removed or being split into subgroups. MENU_GROUP_UPDATETITLES, NaturalDocs::Constants The group should have its auto-titles regenerated. MENU_GROUPLENGTH, NaturalDocs::Builder::HTMLBase The length of one group entry. MENU_INDEX, NaturalDocs::Constants An index. MENU_LENGTHLIMIT, NaturalDocs::Builder::HTMLBase The limit of the menu’s length. MENU_LINK, NaturalDocs::Constants A web link. MENU_LINKLENGTH, NaturalDocs::Builder::HTMLBase The length of one link entry. MENU_SUBTITLE, NaturalDocs::Constants The sub-title of the menu. MENU_SUBTITLELENGTH, NaturalDocs::Builder::HTMLBase The length of the subtitle. MENU_TEXT, NaturalDocs::Constants Arbitrary text. MENU_TEXTLENGTH, NaturalDocs::Builder::HTMLBase The length of one text entry. MENU_TITLE, NaturalDocs::Constants The title of the menu. MENU_TITLELENGTH, NaturalDocs::Builder::HTMLBase The length of the title. MINFILESINNEWGROUP, NaturalDocs::Menu The minimum number of file entries that must be present in a group before it will be automatically created. NAME The name of the language. The name of the topic. The name of the target. NAMESPACE, NaturalDocs::Languages::Advanced::Scope The namespace of the scope, if applicable. OPENING_COMMENT_SYMBOLS, NaturalDocs::Languages::Simple An arrayref of symbols that start a multi-line comment. PACKAGE, NaturalDocs::Languages::Advanced::Scope The package or class of the scope. PARENTS, NaturalDocs::ClassHierarchy::Class A hashref of parents this class has. PROTECTION, NaturalDocs::Languages::Advanced::Scope The protection of the scope, such as public/private/protected. PROTOTYPE The prototype, if it exists and is applicable. The class/symbol/file prototype, or undef if not applicable. The target’s prototype, or undef if none. The symbol’s prototype, if applicable. An existence hashref of all the references in the file. A hashref of the references that can be interpreted as this symbol. The new scope. The scope the topic’s body appears in. SCOPE_RECORD, NaturalDocs::Languages::Advanced An arrayref of NaturalDocs::Languages::Advanced::ScopeChange objects, as generated by the scope stack. SCOPE_STACK, NaturalDocs::Languages::Advanced An arrayref of NaturalDocs::Languages::Advanced::Scope objects serving as a scope stack for parsing. SHEBANG_STRINGS, NaturalDocs::Languages::Simple An arrayref of the all-lowercase strings that can appear in the language’s shebang lines. STATUS, NaturalDocs::Project::File Status since the last build. STYLE, NaturalDocs::Settings::BuildTarget The style of the target. SUMMARY The summary, if it exists. The class/symbol/file summary, or undef if not applicable. The target’s summary, or undef if none. The symbol’s summary, if applicable. SYMBOL The closing symbol of the scope. The name of the symbol. The target symbol. SYMBOLS, NaturalDocs::SymbolTable::File An existence hashref of all the symbols it defines. |