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
E
 EndBuild
NaturalDocs::Builder::BaseNaturalDocs::Builder::HTMLBase
 EndScope, NaturalDocs::Languages::Advanced
 ENUM_GLOBAL
 ENUM_UNDER_PARENT
 ENUM_UNDER_TYPE
 enumTypes, NaturalDocs::Languages::CSharp
 EnumValues
NaturalDocs::Languages::ActionScriptNaturalDocs::Languages::BaseNaturalDocs::Languages::CSharpNaturalDocs::Languages::PerlNaturalDocs::Languages::Simple
 EnumValuesType
 EnumValuesWasSet, NaturalDocs::Languages::Simple
NaturalDocs::Error
 Error Functions, NaturalDocs::ConfigFile
 ErrorCount, NaturalDocs::ConfigFile
 errors, NaturalDocs::ConfigFile
 Event Handlers
NaturalDocs::MenuNaturalDocs::SymbolTableSearchPanel
 excludedInputDirectories, NaturalDocs::Settings
 ExcludedInputDirectories, NaturalDocs::Settings
 ExpandMenu, NaturalDocs::Builder::HTMLBase
@EXPORT
NaturalDocs::Languages::BaseNaturalDocs::Languages::SimpleNaturalDocs::TopicsNaturalDocs::Topics::Type
 Extension Functions, NaturalDocs::SourceDB
 extensionID, NaturalDocs::ImageReferenceTable
 ExtensionID
 ExtensionOf, NaturalDocs::File
 extensions
NaturalDocs::LanguagesNaturalDocs::SourceDB
 Extensions, NaturalDocs::Languages::Base
 extensionUsesDefinitionObjects, NaturalDocs::SourceDB
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.
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’.
my %enumTypes
An existence hash of all the possible enum types.
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.
How enum values are handled in the language.
Returns whether EnumValues was ever changed from the default.
Manages all aspects of error handling in Natural Docs.
sub ErrorCount
Returns how many errors the configuration file has.
my @errors
An array of errors added by AddError().
These functions are called by NaturalDocs::Project only.
my @excludedInputDirectories
An array of input directories to exclude.
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.
our @EXPORT
our @EXPORT
our @EXPORT
our @EXPORT
my $extensionID
The ExtensionID granted by NaturalDocs::SourceDB.
A unique identifier for each NaturalDocs::SourceDB extension as given out by RegisterExtension().
sub ExtensionOf #(path)
Returns the extension of the passed path, or undef if none.
my %extensions
A hash of all the defined languages’ extensions.
my @extensions
An array of NaturalDocs::SourceDB::Extension-derived extensions, as added with RegisterExtension().
Returns an arrayref of the language’s file extensions, or undef if none.
my @extensionUsesDefinitionObjects
An array where the indexes are ExtensionIDs and the values are whether that extension uses its own definition class derived from NaturalDocs::SourceDB::ItemDefinition or it just tracks their existence.
Close