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
D
DecodeReferenceString, NaturalDocs::SymbolTable
sub DecodeReferenceString #(referenceString)
Returns the scope and reference encoded in a reference string.
DecodeSymbolString, NaturalDocs::SymbolTable
sub DecodeSymbolString #(symbolString)
Returns the class and symbol encoded in a symbol string.
DEFAULT_MENU_TITLE, NaturalDocs::Project::File
The file’s default title in the menu.
DefaultMenuTitle, NaturalDocs::Project::File
sub DefaultMenuTitle
Returns the file’s default title on the menu.
DefaultMenuTitleOf, NaturalDocs::Project
sub DefaultMenuTitleOf #(file)
Returns the default menu title of the file.
defaultStyle, NaturalDocs::Settings
my $defaultStyle
The style to be used if an output format doesn’t have its own style specified.
defaultTitlesChanged, NaturalDocs::Menu
my %defaultTitlesChanged
An existence hash of default titles that have changed, since OnDefaultTitleChange() will be called before LoadAndUpdate().
Defines, NaturalDocs::SymbolTable
sub Defines #(class,
symbol)
Returns the symbol the passed class and name define.
DefinesReference, NaturalDocs::SymbolTable::File
sub DefinesReference #(referenceString)
Returns whether the file defines the passed reference or not.
DefinesSymbol, NaturalDocs::SymbolTable::File
sub DefinesSymbol #(symbolString)
Returns whether the file defines the passed symbol or not.
sub Definitions
Returns an array of the files that define this class, or an empty array if none.
sub Definitions
Returns an array of all the files that define this reference.
sub Definitions
Returns an array of all the files that define this symbol.
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.
DeleteAllInterpretationsButCurrent, NaturalDocs::SymbolTable::Reference
sub DeleteAllInterpretationsButCurrent
Deletes all interpretations except for the current one.
DeleteAllReferences, NaturalDocs::SymbolTable::Symbol
sub DeleteAllReferences
Removes all references that can be interpreted as this symbol.
DeleteChild, NaturalDocs::ClassHierarchy::Class
sub DeleteChild #(child)
Deletes a child from the class.
sub DeleteClass #(file,
class)
Deletes a class definition from a file.
sub DeleteClass #(class)
Deletes a class from the file.
sub DeleteDefinition #(file)
Removes the file definition of this class and returns true if there are no more definitions.
sub DeleteDefinition #(file)
Removes a reference definition.
sub DeleteDefinition #(file)
Removes a symbol definition.
DeleteFile, NaturalDocs::ClassHierarchy
sub DeleteFile #(file)
Deletes a file and everything defined in it.
DeleteFromGroup, NaturalDocs::Menu::Entry
sub DeleteFromGroup #(index)
Deletes an entry from the group content by index.
DeleteInterpretation, NaturalDocs::SymbolTable::Reference
sub DeleteInterpretation #(symbolString)
Deletes a symbol that this reference can be interpreted as.
sub DeleteParent #(file,
class,
parent)
Deletes a class’ parent definiton.
sub DeleteParent #(file,
parent)
Deletes a parent definition from the class.
sub DeleteParent #(class,
parent)
Deletes a parent from a class.
sub DeleteReference #(referenceString,
file)
Deletes a reference from the table.
sub DeleteReference #(referenceString)
Removes a reference definition.
sub DeleteReference #(referenceString)
Deletes a reference that can be interpreted as this symbol.
sub DeleteSymbol #(symbolString,
file)
Removes a symbol definition from the table.
sub DeleteSymbol #(symbolString)
Removes a symbol definition.
DetectIndexGroups, NaturalDocs::Menu
Finds groups that are primarily used for indexes and gives them the MENU_GROUP_ISINDEXGROUP flag.
DetectOrder, NaturalDocs::Menu
Detects the order of the entries in all groups that have the MENU_GROUP_UPDATEORDER flag set.
Directory, NaturalDocs::Settings::BuildTarget
sub Directory
Returns the directory for the traget’s output files.
DIRECTORY, NaturalDocs::Settings::BuildTarget
The output directory of the target.
Disk Functions, NaturalDocs::File
documentedOnly, NaturalDocs::Settings
my $documentedOnly
Whether undocumented code aspects should be included in the output.
DocumentedOnly, NaturalDocs::Settings
sub DocumentedOnly
Returns whether undocumented code aspects should be included in the output.
E
sub EndBuild #(hasChanged)
Define this function if the package needs to do anything at the end of the build process.
Checks that the project’s CSS file is the same as the master CSS file, unless -s Custom is specified.
sub EndOfPrototype #(type,
stringRef,
falsePositives)
Ada’s syntax uses the semicolons and commas parameter style shown below, yet also uses semicolons to end function prototypes.
sub EndOfPrototype #(type,
stringRef,
falsePositives)
Pascal’s syntax uses the semicolons and commas parameter style shown below, yet also uses semicolons to end function prototypes.
sub EndOfPrototype #(type,
stringRef,
falsePositives)
Microsoft’s SQL specifies parameters as shown below.
sub EndOfPrototype #(type,
stringRef,
falsePositives)
Returns the index of the end of the prototype in a string.
sub EndOfPrototype #(type,
stringRef,
falsePositives)
Tcl’s function syntax is shown below.
EndScope, NaturalDocs::Languages::Advanced
sub EndScope #(lineNumber)
Records the end of the current scope level.
Error Functions, NaturalDocs::ConfigFile
ErrorCount, NaturalDocs::ConfigFile
sub ErrorCount
Returns how many errors the configuration file has.
errors, NaturalDocs::ConfigFile
my @errors
An array of errors added by AddError().
Event Handlers, NaturalDocs::Menu
These functions are called by NaturalDocs::Project only.
ExpandMenu, NaturalDocs::Builder::HTMLBase
Determines which groups should be expanded.
my @extensions
An array of all the extension packages.
my %extensions
A hash of all the defined languages’ extensions.
Returns all the possible extensions of the language’s files as an arrayref.
sub Extensions
Returns an arrayref of the extensions of the language’s files.
sub Extensions
Returns all the possible extensions of the language’s files as an arrayref.
EXTENSIONS, NaturalDocs::Languages::Simple
An arrayref of the all-lowercase extensions of the language’s files.