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
$#!
 #Content
 #Footer
 #IFirstHeading
 #IFirstSymbolPrefix
 #ILastSymbolPrefix
 #Index
 #IOnlySymbolPrefix
 #MainTopic
 #Menu
 #MSearchEverything
 #MSearchField
 #MSearchPanel
 #MSearchResults
 #MSearchResultsWindow
 #MSearchRseultsWindowClose
 #MSearchType
 #MSelected
 #SearchResults
A
 abbreviations, NaturalDocs::Builder::HTMLBase
 Action Functions
 Activate, SearchPanel
 Activation Functions, SearchPanel
 Add, NaturalDocs::Builder
 ADD_HIDDEN_BREAKS
 AddAndRemoveIndexes, NaturalDocs::Menu
 AddAutoTopic, NaturalDocs::Languages::Advanced
 AddChild, NaturalDocs::ClassHierarchy::Class
 AddClass
 AddDefinition
 AddDoubleSpaces, NaturalDocs::Builder::HTMLBase
 AddError, NaturalDocs::ConfigFile
 AddHiddenBreaks, NaturalDocs::Builder::HTMLBase
 AddImageFileReference, NaturalDocs::Project
 AddInterpretation
 AddItem
 AddPackageDelineators, NaturalDocs::Parser
 AddParameter, NaturalDocs::Languages::Prototype
 AddParentReference
 AddReference
 AddSymbol
 AddToClassHierarchy, NaturalDocs::Parser
 AddToCodeBlock, NaturalDocs::Parser::Native
 AddToScopeRecord, NaturalDocs::Languages::Advanced
 AddUsing
 AfterParameters, NaturalDocs::Languages::Prototype
 AllIndexableTypes, NaturalDocs::Topics
$amount
 Amp Chars
 AnalyzeChanges
 AnalyzeWatchedFileChanges, NaturalDocs::SourceDB
 AppURL, NaturalDocs::Settings
 AppVersion, NaturalDocs::Settings
 Assumptions
 Auto-Adjustment Functions, NaturalDocs::Menu
 AUTO_TOPICS
 AutoPlaceNewFiles, NaturalDocs::Menu
 AutoTopics, NaturalDocs::Languages::Advanced
Parent element containing all topics.
The page footer.
The ID of the first IHeading to appear in the file.
The ID for the first ISymbolPrefix to appear under an IHeading.
The ID for the last ISymbolPrefix to appear under an IHeading.
Parent element for the entire index.
The ID if there is only one ISymbolPrefix for an IHeading.
The ID given to the main topic, which is the first in the file.
Parent element containing the entire menu.
The #MSearchType option for the Everything index.
The text input field of the search panel.
Contains all the search controls.
Contains the iframe that will hold the results.
Contains all the search results elements.
The link to manually close the search results window.
The drop down type selector of the search panel.
The ID of the currently selected MFile or MIndex.
Parent element for the entire page.
my %abbreviations
An existence hash of acceptable abbreviations.
this.Activate = function(isActive,
ignoreDeactivateDelay)
Activates or deactivates the search panel, resetting things to their default values if necessary.
Functions that handle whether the entire panel is active or not.
sub Add #(package)
Adds an output package to those available for use.
Just a synonym for “1” so that setting the flag on StringToHTML() is clearer in the calling code.
sub AddAndRemoveIndexes
Automatically adds and removes index entries on the menu as necessary.
sub AddAutoTopic #(topic)
Adds a NaturalDocs::Parser::ParsedTopic to AutoTopics().
sub AddChild #(child)
Adds a child SymbolString to the class.
sub AddClass #(file,
class,
languageName)
Adds a class to the hierarchy.
sub AddClass #(class)
Adds a rew class SymbolString to the file.
sub AddDefinition #(file)
Adds a rew definition of this class and returns if that was the first definition.
sub AddDefinition #(
   ExtensionID extension,
   string itemString,
   FileName file,
   optional NaturalDocs::SourceDB::ItemDefinition definition
) => bool
Adds a definition to an item.
sub AddDefinition #(
   FileName file,
   optional NaturalDocs::SourceDB::ItemDefinition definition
) => bool
Adds a definition for the passed FileName.
sub AddDefinition #(ExtensionID extension,
string itemString,
NaturalDocs::SourceDB::ItemDefinition definition) => bool
Adds a definition for the passed item string.
sub AddDefinition #(file)
Adds a reference definition.
sub AddDefinition #(file,
type,
prototype,
summary)
Adds a symbol definition.
sub AddDoubleSpaces #(text)
Adds second spaces after the appropriate punctuation with   so they show up in HTML.
sub AddError #(message,
lineNumber)
Stores an error for the current configuration file.
sub AddHiddenBreaks #(string)
Adds hidden breaks to symbols.
sub AddImageFileReference #(FileName imageFile)
Adds a reference to the passed image FileName.
sub AddInterpretation #(referenceString,
symbol,
score)
Adds an interpretation to an existing reference.
sub AddInterpretation #(symbol,
score)
Adds a symbol that this reference can be interpreted as.
sub AddItem #(ExtensionID extension,
string itemString,
NaturalDocs::SourceDB::Item item) => bool
Adds the passed item to the database.
sub AddItem #(ExtensionID extension,
string itemString) => bool
Adds an item to this file.
sub AddPackageDelineators
Adds section and class topics to make sure the package is correctly represented in the documentation.
sub AddParameter #(parameter)
Adds a NaturalDocs::Languages::Prototype::Parameter to the list.
sub AddParentReference #(file,
class,
symbol,
scope,
using,
resolvingFlags) or (file, class, reference)
Adds a class-parent relationship to the hierarchy.
sub AddParentReference #(reference,
file,
referenceTranslations)
Adds a parent reference to the class and return whether it resulted in a new parent class.
sub AddParentReference #(class,
parentReference)
Adds a parent ReferenceString to a class SymbolString.
sub AddReference #(FileName file,
string referenceText)
Adds a new image reference.
sub AddReference
Increases the number of references to this image file by one.
sub AddReference #(type,
symbol,
scope,
using,
file,
resolvingFlags) or (referenceString, 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.
sub AddSymbol #(symbol,
file,
type,
prototype,
summary)
Adds a symbol definition to the table, if it doesn’t already exist.
sub AddSymbol #(symbol)
Adds a SymbolString definition.
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.
sub AddToCodeBlock #(line,
codeBlockRef,
removedSpacesRef)
Adds a line of text to a code block, handling all the indentation processing required.
sub AddToScopeRecord #(newScope,
lineNumber)
Adds a change to the scope record, condensing unnecessary entries.
sub AddUsing #(using)
Adds a Using SymbolString to the current scope.
sub AddUsing #(using)
Adds a SymbolString to the Using() array.
Returns the part of the prototype after the parameter list, if any.
sub AllIndexableTypes
Returns an array of all possible indexable TopicTypes.
my $amount
These are the only amp chars supported, and will appear everywhere.
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().
sub AnalyzeWatchedFileChanges
Analyzes the watched file for changes.
sub AppURL
Returns a string of the project’s current web address.
sub AppVersion
Returns Natural Docs’ version number as an integer.
SourceDB is built around certain assumptions.
An arrayref of NaturalDocs::Parser::ParsedTopics generated automatically from the code.
sub AutoPlaceNewFiles #(fileInMenu)
Adds files to the menu that aren’t already on it, attempting to guess where they belong.
sub AutoTopics
Returns the arrayref of automatically generated topics, or undef if none.
Close