Index - Natural Docs

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
	Data Types, NaturalDocs::BinaryFile
	DataFile, NaturalDocs::Project
	deactivateTimeout, SearchPanel
	deactivateTimeoutLength, SearchPanel
	declarationEnders, NaturalDocs::Languages::ActionScript
	Default TopicTypes
	DEFAULT_MENU_TITLE
	DEFAULT_VALUE
	DEFAULT_VALUE_PREFIX
	DefaultMenuTitle, NaturalDocs::Project::SourceFile
	DefaultMenuTitleOf, NaturalDocs::Project
	defaultTitlesChanged, NaturalDocs::Menu
	DefaultValue, NaturalDocs::Languages::Prototype::Parameter
	DefaultValuePrefix, NaturalDocs::Languages::Prototype::Parameter
NaturalDocs::	DefineMembers
	DefinesReference, NaturalDocs::SymbolTable::File
	DefinesSymbol, NaturalDocs::SymbolTable::File
	Definition Functions NaturalDocs::SourceDB NaturalDocs::SourceDB::Item NaturalDocs::SourceDB::WatchedFileDefinitions
	Definitions NaturalDocs::ClassHierarchy::Class NaturalDocs::SymbolTable::Reference NaturalDocs::SymbolTable::Symbol
	DEFINITIONS Global Modules\NaturalDocs\ClassHierarchy\Class.pm Modules\NaturalDocs\SymbolTable\Reference.pm Modules\NaturalDocs\SymbolTable\Symbol.pm NaturalDocs::SourceDB::Item
	DeleteAllInterpretationsButCurrent, NaturalDocs::SymbolTable::Reference
	DeleteAllReferences, NaturalDocs::SymbolTable::Symbol
	DeleteChild, NaturalDocs::ClassHierarchy::Class
	DeleteClass NaturalDocs::ClassHierarchy NaturalDocs::ClassHierarchy::File
	DeleteDefinition NaturalDocs::ClassHierarchy::Class NaturalDocs::SourceDB NaturalDocs::SourceDB::Item NaturalDocs::SourceDB::WatchedFileDefinitions NaturalDocs::SymbolTable::Reference NaturalDocs::SymbolTable::Symbol
	DeleteFile, NaturalDocs::ClassHierarchy
	DeleteFromGroup, NaturalDocs::Menu::Entry
	DeleteImageFileReference, NaturalDocs::Project
	DeleteInterpretation, NaturalDocs::SymbolTable::Reference
	DeleteItem NaturalDocs::SourceDB NaturalDocs::SourceDB::File
	DeleteParentReference NaturalDocs::ClassHierarchy NaturalDocs::ClassHierarchy::Class NaturalDocs::ClassHierarchy::File
	DeleteReference NaturalDocs::Project::ImageFile NaturalDocs::SymbolTable NaturalDocs::SymbolTable::File NaturalDocs::SymbolTable::Symbol
	DeleteSymbol NaturalDocs::SymbolTable NaturalDocs::SymbolTable::File
	DetectIndexGroups, NaturalDocs::Menu
	DetectOrder, NaturalDocs::Menu
	DetermineImageDimensions, NaturalDocs::Project
	Diagram Conventions
	Directory, NaturalDocs::Settings::BuildTarget
	DIRECTORY
	Disk Functions, NaturalDocs::File
	documentedOnly, NaturalDocs::Settings
	DocumentedOnly, NaturalDocs::Settings
	DOM Elements, SearchPanel
	DOMPopupSearchResults, SearchPanel
	DOMPopupSearchResultsWindow, SearchPanel
	DOMSearchField, SearchPanel
	DOMSearchPanel, SearchPanel
	DOMSearchType, SearchPanel
	dontRebuildFiles, NaturalDocs::ClassHierarchy

All the integer data types are written most significant byte first, aka big endian.

sub DataFile #( string file )

Returns the full path to the passed data file.

The timeout used between when a control is deactivated and when the entire panel is deactivated.

this.deactivateTimeoutLength

The length of deactivateTimeout in thousandths of a second.

my %declarationEnders

An existence hash of all the tokens that can end a declaration.

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.

sub DefaultMenuTitle

Returns the file’s default title on the menu.

sub DefaultMenuTitleOf #( file )

Returns the default menu title of the FileName.

my %defaultTitlesChanged

An existence hash of default titles that have changed, since OnDefaultTitleChange() will be called before LoadAndUpdate().

The default value expression, if any.

The default value prefix, which should be aligned separately, if any.

A custom Perl pragma to define member constants and accessors for use in Natural Docs objects while supporting inheritance.

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.

These functions should be called by NaturalDocs::SourceDB.

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.

An existence hashref of all the FileNames which define this class.

A hashref that maps FileNames to either NaturalDocs::SourceDB::ItemDefinition-derived objects or serves as an existence hashref depending on whether the extension only tracks existence.

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.

The diagrams are designed for clarity.

Returns the directory for the target’s output files.

The output directory of the target.

my $documentedOnly

Whether undocumented code aspects should be included in the output.

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()

my $dontRebuildFiles

A bool to set if you don’t want changes in the hierarchy to cause files to be rebuilt.