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
U
 unbuiltFilesWithContent, NaturalDocs::Project
 UnbuiltFilesWithContent, NaturalDocs::Project
$underline, NaturalDocs::Parser::Native
$underlineHasWhitespace, NaturalDocs::Parser::Native
 Unframed HTML Search
 Unobscure, NaturalDocs::ConfigFile
 UpdateFile, NaturalDocs::Builder::HTML
 UpdateImage
 UpdateIndex, NaturalDocs::Builder::HTML
 UpdateMenu
 Usage, NaturalDocs::ImageReferenceTable
 Usage and Dependencies, NaturalDocs::Settings
 UserConfigFile, NaturalDocs::Project
 userConfigFiles, NaturalDocs::Project
 UserConfigFileStatus, NaturalDocs::Project
 Using
 USING
V
 variableModifiers, NaturalDocs::Languages::CSharp
 Variables
NaturalDocs::Version
 VersionInt
 Virtual Types, NaturalDocs::Constants
 virtualLines, NaturalDocs::ConfigFile
W
 WAS_USED
 WasUsed, NaturalDocs::Project::ImageFile
 WasUsed versus References, NaturalDocs::Project::ImageFile
 Watched File Functions, NaturalDocs::SourceDB
 watchedFile
 watchedFileDefinitions, NaturalDocs::SourceDB
 watchedFileName
 watchedFileSymbolDefinitions, NaturalDocs::SymbolTable
 WatchFileForChanges
 WatchingFileForChanges, NaturalDocs::SourceDB
 Width, NaturalDocs::Project::ImageFile
 WIDTH
 WriteAString16, NaturalDocs::BinaryFile
 WriteMenuEntries, NaturalDocs::Menu
 WritePreviousMenuStateEntries, NaturalDocs::Menu
 WriteUInt16, NaturalDocs::BinaryFile
 WriteUInt32, NaturalDocs::BinaryFile
 WriteUInt8, NaturalDocs::BinaryFile
 Writing Functions, NaturalDocs::BinaryFile
X
 XChomp
 XML Tag Type
 XML_CLOSING_TAG
 XML_OPENING_TAG
 XML_SELF_CONTAINED_TAG
my %unbuiltFilesWithContent
An existence hash of all the FileNames that have Natural Docs content but are not part of filesToBuild.
sub UnbuiltFilesWithContent
Returns an existence hashref of the FileNames that have Natural Docs content but are not part of FilesToBuild().
my $underline
my $underlineHasWhitespace
sub Unobscure #(text)
Restores text encoded with Obscure() and returns it.
sub UpdateFile #(sourceFile)
Updates an output file.
sub UpdateImage #(file)
Define this function to add or update the passed image in the output.
sub UpdateImage #(file)
Define this function to add or update the passed image in the output.
sub UpdateIndex #(type)
Updates an index’s output file.
sub UpdateMenu
Define this function to make the package update the menu.
sub UpdateMenu
Builds the menu file.
sub UpdateMenu
Updates the menu in all the output files that weren’t rebuilt.
sub UserConfigFile #(string file)
Returns the full path to the passed user configuration file.
my %userConfigFiles
A hash mapping all the user configuration file names without paths to their FileStatus.
sub UserConfigFileStatus #(string file)
Returns the FileStatus of the passed user configuration file.
sub Using
Returns an arrayref of SymbolStrings for using statements, or undef if none
sub Using
Returns an arrayref of additional scope SymbolStrings available to the topic via “using” statements, or undef if none.
An arrayref of SymbolStrings for using statements, or undef if none.
my %variableModifiers
An existence hash of all the acceptable variable modifiers.
A package for handling version information.
A comparable integer representing a version number.
These are only groups of constants, but should be treated like typedefs or enums.
my @virtualLines
An array of virtual lines if a line from the file contained more than one.
Whether the image was used the last time Natural Docs was run.
Returns whether this image file was used during the last Natural Docs execution.
WasUsed() is a simple true/false that notes whether this image file was used the last time Natural Docs was run.
my $watchedFile
A NaturalDocs::ClassHierarchy::File object of the file being watched for changes.
my $watchedFile
When a file is being watched for changes, will be a NaturalDocs::SourceDB::File for that file.
my $watchedFile
A NaturalDocs::SymbolTable::File object of the file being watched for changes.
my $watchedFileDefinitions
When a file is being watched for changes, will be a NaturalDocs::SourceDB::WatchedFileDefinitions object.
my $watchedFileName
The FileName of the watched file, if any.
my $watchedFileName
When a file is being watched for changes, will be the FileName of the file being watched.
my $watchedFileName
The FileName of the watched file, if any.
my %watchedFileSymbolDefinitions
A hashref of the symbol definition information for all the SymbolStrings in the watched file.
sub WatchFileForChanges #(file)
Watches a file for changes, which can then be applied by AnalyzeChanges().
sub WatchFileForChanges #(FileName filename)
Begins watching a file for changes.
sub WatchFileForChanges #(file)
Tracks a file to see if any symbols or references were changed or deleted in ways that would require other files to be rebuilt.
sub WatchingFileForChanges # => bool
Returns whether we’re currently watching a file for changes or not.
Returns the width in pixels, undef if it can’t be determined, and -1 if determination hasn’t been attempted yet.
The image width.
sub WriteAString16 #(string value)
Writes an AString16 to the open file.
sub WriteMenuEntries #(entries,
fileHandle,
indentChars,
relativeFiles)
A recursive function to write the contents of an arrayref of NaturalDocs::Menu::Entry objects to disk.
sub WritePreviousMenuStateEntries #(entries,
fileHandle)
A recursive function to write the contents of an arrayref of NaturalDocs::Menu::Entry objects to disk.
sub WriteUInt16 #(UInt16 value)
Writes a UInt32 to the open file.
sub WriteUInt32 #(UInt32 value)
Writes a UInt32 to the open file.
sub WriteUInt8 #(UInt8 value)
Writes a UInt8 to the open file.
sub XChomp #(lineRef)
A cross-platform chomp function.
The tag is a closing one, such as /tag.
The tag is an opening one, such as tag.
The tag is self contained, such as tag /.
Close