Function 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
 DataFile, NaturalDocs::Project
 DefaultMenuTitle, NaturalDocs::Project::SourceFile
 DefaultMenuTitleOf, NaturalDocs::Project
 DefaultValue, NaturalDocs::Languages::Prototype::Parameter
 DefaultValuePrefix, NaturalDocs::Languages::Prototype::Parameter
 DefinesReference, NaturalDocs::SymbolTable::File
 DefinesSymbol, NaturalDocs::SymbolTable::File
 Definitions
 DeleteAllInterpretationsButCurrent, NaturalDocs::SymbolTable::Reference
 DeleteAllReferences, NaturalDocs::SymbolTable::Symbol
 DeleteChild, NaturalDocs::ClassHierarchy::Class
 DeleteClass
 DeleteDefinition
 DeleteFile, NaturalDocs::ClassHierarchy
 DeleteFromGroup, NaturalDocs::Menu::Entry
 DeleteImageFileReference, NaturalDocs::Project
 DeleteInterpretation, NaturalDocs::SymbolTable::Reference
 DeleteItem
 DeleteParentReference
 DeleteReference
 DeleteSymbol
 DetectIndexGroups, NaturalDocs::Menu
 DetectOrder, NaturalDocs::Menu
 DetermineImageDimensions, NaturalDocs::Project
 Directory, NaturalDocs::Settings::BuildTarget
 DocumentedOnly, NaturalDocs::Settings
 DOMPopupSearchResults, SearchPanel
 DOMPopupSearchResultsWindow, SearchPanel
 DOMSearchField, SearchPanel
 DOMSearchPanel, SearchPanel
 DOMSearchType, SearchPanel
E
 EndBuild
 EndScope, NaturalDocs::Languages::Advanced
 EnumValues
 EnumValuesWasSet, NaturalDocs::Languages::Simple
 ErrorCount, NaturalDocs::ConfigFile
 ExcludedInputDirectories, NaturalDocs::Settings
 ExpandMenu, NaturalDocs::Builder::HTMLBase
 ExtensionOf, NaturalDocs::File
 Extensions, NaturalDocs::Languages::Base
sub DataFile #(string file)
Returns the full path to the passed data file.
sub DefaultMenuTitle
Returns the file’s default title on the menu.
sub DefaultMenuTitleOf #(file)
Returns the default menu title of the FileName.
The default value expression, if any.
The default value prefix, which should be aligned separately, if any.
sub DefinesReference #(referenceString)
Returns whether the file defines the passed ReferenceString or not.
sub DefinesSymbol #(symbol)
Returns whether the file defines the passed SymbolString or not.
sub Definitions
Returns an array of the FileNames that define this class, or an empty array if none.
sub Definitions
Returns an array of all the FileNames that define this reference.
sub Definitions
Returns an array of all the FileNames that define this symbol.
sub DeleteAllInterpretationsButCurrent
Deletes all interpretations except for the current one.
sub DeleteAllReferences
Removes all references that can be interpreted as this symbol.
sub DeleteChild #(child)
Deletes a child SymbolString from the class.
sub DeleteClass #(file,
class)
Deletes a class definition from a file.
sub DeleteClass #(class)
Deletes a class SymbolString from the file.
sub DeleteDefinition #(file)
Removes the definition of this class and returns if there are no more definitions.
sub DeleteDefinition #(ExtensionID extension,
string itemString,
FileName file) => bool
Removes the definition for the passed item.
sub DeleteDefinition #(FileName file) => bool
Removes the definition for the passed FileName.
sub DeleteDefinition #(ExtensionID extension,
string itemString) => bool
Removes the definition for the passed item string.
sub DeleteDefinition #(file)
Removes a reference definition.
sub DeleteDefinition #(file)
Removes a symbol definition.
sub DeleteFile #(file)
Deletes a file and everything defined in it.
sub DeleteFromGroup #(index)
Deletes an entry from the group content by index.
sub DeleteImageFileReference #(FileName imageFile)
Deletes a reference from the passed image FileName.
sub DeleteInterpretation #(symbol)
Deletes a symbol that this reference can be interpreted as.
sub DeleteItem #(ExtensionID extension,
string itemString) => bool
Deletes the record of the passed ExtensionID and item string.
sub DeleteItem #(ExtensionID extension,
string itemString) => bool
Deletes the passed item.
sub DeleteParentReference #(file,
class,
reference)
Deletes a class’ parent reference and returns whether it resulted in the loss of a parent class.
sub DeleteParentReference #(reference,
file,
referenceTranslations)
Deletes a parent reference from the class and return whether it resulted in a loss of a parent class.
sub DeleteParentReference #(class,
parent)
Deletes a parent ReferenceString from a class SymbolString.
sub DeleteReference
Decreases the number of references to this image file by one.
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 #(symbol,
file)
Removes a symbol definition from the table.
sub DeleteSymbol #(symbol)
Removes a SymbolString definition.
sub DetectIndexGroups
Finds groups that are primarily used for indexes and gives them the MENU_GROUP_ISINDEXGROUP flag.
sub DetectOrder #(forceAll)
Detects the order of the entries in all groups that have the MENU_GROUP_UPDATEORDER flag set.
sub DetermineImageDimensions #(FileName imageFile)
Attempts to determine the dimensions of the passed image and apply them to their object in imageFiles.
Returns the directory for the target’s output files.
sub DocumentedOnly
Returns whether undocumented code aspects should be included in the output.
this.DOMPopupSearchResults = function()
this.DOMPopupSearchResultsWindow = function()
this.DOMSearchField = function()
this.DOMSearchPanel = function()
this.DOMSearchType = function()
sub EndBuild #(hasChanged)
Define this function if the package needs to do anything at the end of the build process.
sub EndBuild #(hasChanged)
Synchronizes the projects CSS and JavaScript files.
sub EndScope #(lineNumber)
Records the end of the current scope level.
sub EnumValues
Returns the EnumValuesType that describes how the language handles enums.
sub EnumValues
Returns the EnumValuesType that describes how the language handles enums.
sub EnumValues
Returns the EnumValuesType that describes how the language handles enums.
sub EnumValues
Returns the EnumValuesType that describes how the language handles enums.
sub SetEnumValues #(EnumValuesType newBehavior)
Returns the EnumValuesType that describes how the language handles enums.
Returns whether EnumValues was ever changed from the default.
sub ErrorCount
Returns how many errors the configuration file has.
sub ExcludedInputDirectories
Returns an arrayref of input directories to exclude.
sub ExpandMenu #(
   FileName sourceFile,
   TopicType indexType,
   NaturalDocs::Menu::Entry[] selectionHierarchy,
   int rootLength
) -> int[] groupsToExpand
Determines which groups should be expanded.
sub ExtensionOf #(path)
Returns the extension of the passed path, or undef if none.
Returns an arrayref of the language’s file extensions, or undef if none.
Close