Index - Natural Docs

Natural Docs

Version 1.2

Natural Docs

Packages

Settings:: BuildTarget

ClassHierarchy:: Class

ClassHierarchy:: File

Everything

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

unbuiltFilesWithContent, NaturalDocs::Project

my %unbuiltFilesWithContent

An existence hashref of all the files that have Natural Docs content but are not part of filesToBuild.

UnbuiltFilesWithContent, NaturalDocs::Project

sub UnbuiltFilesWithContent

Returns an existence hashref of files that have Natural Docs content but are not part of FilesToBuild().

UnframedPage

An unframed page.

Unobscure, NaturalDocs::ConfigFile

sub Unobscure #(text)

Restores text encoded with Obscure() and returns it.

UpdateFile, NaturalDocs::Builder::HTML

sub UpdateFile #(sourceFile)

Updates an output file.

UpdateIndex, NaturalDocs::Builder::HTML

sub UpdateIndex #(type)

Updates an index’s output file.

UpdateMenu

NaturalDocs:: Builder:: Base

NaturalDocs:: Builder:: FramedHTML

NaturalDocs:: Builder:: HTML

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.

UseDirectory

sub UseDirectory #	(	directory,
		directory,
		directory ...	)

Does the equivalent of “use [module]” for every .pm file in a directory and all its subdirectories.

VARIABLE_ENDERS, NaturalDocs::Languages::Simple

An arrayref of symbols that can end a variable declaration.

VariableEnders, NaturalDocs::Languages::Simple

sub VariableEnders

Returns an arrayref of the symbols that end a variable declaration, or undef if not applicable.

Variables

NaturalDocs:: Builder

NaturalDocs:: ClassHierarchy

NaturalDocs:: ConfigFile

NaturalDocs:: Extensions

NaturalDocs:: Languages

NaturalDocs:: Languages:: Pascal

NaturalDocs:: Menu

NaturalDocs:: Parser

NaturalDocs:: Parser:: Native

NaturalDocs:: Project

NaturalDocs:: Settings

NaturalDocs:: SymbolTable

NaturalDocs:: Topics

watchedFile

NaturalDocs:: ClassHierarchy

NaturalDocs:: SymbolTable

my $watchedFile

A NaturalDocs::ClassHierarchy::File object of the file being watched for changes.

my $watchedFile

A NaturalDocs::SymbolTable::File object of the file being watched for changes.

watchedFileName

NaturalDocs:: ClassHierarchy

NaturalDocs:: SymbolTable

my $watchedFileName

The file name of the watched file, if any.

my $watchedFileName

The file name of the watched file, if any.

watchedFileSymbolDefinitions, NaturalDocs::SymbolTable

my %watchedFileSymbolDefinitions

A hashref of the symbol definition information for all the symbols in the watched file.

WatchFileForChanges

NaturalDocs:: ClassHierarchy

NaturalDocs:: SymbolTable

sub WatchFileForChanges #(file)

Watches a file for changes, which can then be applied by AnalyzeChanges().

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.

WriteMenuEntries, NaturalDocs::Menu

sub WriteMenuEntries #	(	entries,
		fileHandle,
		indentChars	)

A recursive function to write the contents of an arrayref of NaturalDocs::Menu::Entry objects to disk.

WritePreviousMenuStateEntries, NaturalDocs::Menu

sub WritePreviousMenuStateEntries #	(	entries,
		fileHandle	)

A recursive function to write the contents of an arrayref of NaturalDocs::Menu::Entry objects to disk.

XChomp

sub XChomp #(lineRef)

A cross-platform chomp function.