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
A
sub Add #(package)
Adds an output package to those available for use.
sub Add #(package)
Adds an extension package to Natural Docs.
sub Add #(languageObject)
Adds a NaturalDocs::Languages::Language object to the package.
AddAndRemoveIndexes, NaturalDocs::Menu
sub AddAndRemoveIndexes
Automatically adds and removes index entries on the menu as necessary.
AddAutoTopic, NaturalDocs::Languages::Advanced
sub AddAutoTopic #(topic)
Adds a NaturalDocs::Parser::ParsedTopic to AutoTopics().
AddChild, NaturalDocs::ClassHierarchy::Class
sub AddChild #(child)
Adds a child to the class.
sub AddClass #(file,
class)
Adds a class to the hierarchy.
sub AddClass #(class)
Adds a rew class to the file.
sub AddDefinition #(file)
Adds a rew file that defines this class.
sub AddDefinition #(file)
Adds a reference definition.
sub AddDefinition #(file,
type,
prototype,
summary)
Adds a symbol definition.
AddDoubleSpaces, NaturalDocs::Builder::HTMLBase
Adds second spaces after the appropriate punctuation with   so they show up in HTML.
AddError, NaturalDocs::ConfigFile
sub AddError #(lineNumber,
message)
Stores an error for the current configuration file.
AddHiddenBreaks, NaturalDocs::Builder::HTMLBase
Adds hidden breaks to symbols.
sub AddInterpretation #(referenceString,
class,
symbol,
score)
Adds an interpretation to an existing reference.
sub AddInterpretation #(referenceString,
score)
Adds a symbol that this reference can be interpreted as.
sub AddParent #(file,
class,
parent,
dontRebuild)
Adds a class-parent relationship to the hierarchy.
sub AddParent #(file,
parent)
Adds a parent definition to the class.
sub AddParent #(class,
parent)
Adds a parent to a class.
sub AddReference #(scope,
reference,
file)
Adds a reference to the table, if it doesn’t already exist.
sub AddReference #(referenceString)
Adds a reference definition.
sub AddReference #(referenceString,
score)
Adds a reference that can be interpreted as this symbol.
AddScopeDelineators, NaturalDocs::Parser
sub AddScopeDelineators
Adds section and class topics to make sure the scope is correctly represented in the documentation.
sub AddSymbol #(class,
symbol,
file,
type,
prototype,
summary)
Adds a symbol definition to the table, if it doesn’t already exist.
sub AddSymbol #(symbolString)
Adds a symbol definition.
AddToClassHierarchy, NaturalDocs::Parser
sub AddToClassHierarchy
Adds any class topics to the class hierarchy, since they may not have been called with OnClass() if they didn’t match up to an auto-topic.
AddToCodeBlock, NaturalDocs::Parser::Native
sub AddToCodeBlock #(line,
codeBlockRef,
removedSpacesRef)
Adds a line of text to a code block, handling all the indentation processing required.
AddToScopeRecord, NaturalDocs::Languages::Advanced
sub AddToScopeRecord #(newScope,
lineNumber)
Adds a change to the scope record, condensing unnecessary entries.
sub AfterFileParsed #(file,
parsedFile)
Called after a file has been parsed, but before it is scanned for symbols or turned into output.
sub AfterFileParsed #(file,
parsedFile)
Called after a file has been parsed, but before it is scanned for symbols or turned into output.
AllIndexable, NaturalDocs::Topics
sub AllIndexable
Returns an array of all possible indexable Topic Types.
sub AnalyzeChanges
Checks the watched file for any changes that occured since the last time is was parsed, and updates the hierarchy as necessary.
sub AnalyzeChanges
Handles any changes found when reparsing a file using WatchFileForChanges().
AppURL, NaturalDocs::Settings
sub AppURL
Returns a string of the project’s current web address.
AppVersion, NaturalDocs::Settings
sub AppVersion
Returns Natural Docs’ version number as an integer.
AutoPlaceNewFiles, NaturalDocs::Menu
sub AutoPlaceNewFiles #(fileInMenu)
Adds files to the menu that aren’t already on it, attempting to guess where they belong.
AutoTopics, NaturalDocs::Languages::Advanced
sub AutoTopics
Returns the arrayref of automatically generated topics, or undef if none.