Index - Natural Docs

FalsePositivesForSemicolonsInParenthesis, NaturalDocs::Languages::Simple

sub FalsePositivesForSemicolonsInParenthesis #(stringRef)

Returns an existence hashref of potential false positives for languages that can end a function prototype with a semicolon but also use them to separate parameters.

file, NaturalDocs::ConfigFile

my $file

The current configuration file being parsed.

File

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: ReferenceTarget

sub File

Returns the file the class/symbol is defined in, if applicable.

sub File

Returns the file the target is defined in.

FILE

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: ReferenceTarget

The file the class/symbol is defined in.

The file the target is defined as.

File Functions

NaturalDocs:: ClassHierarchy

NaturalDocs:: Menu

NaturalDocs:: SymbolTable

File Status Constants, NaturalDocs::Constants

FILE_CHANGED, NaturalDocs::Constants

The file has been modified since the last run.

FILE_DOESNTEXIST, NaturalDocs::Constants

The file doesn’t exist, or was deleted.

FILE_NEW, NaturalDocs::Constants

The file has been added since the last run.

FILE_SAME, NaturalDocs::Constants

The file hasn’t been modified since the last run.

fileChanged, NaturalDocs::Menu

my $fileChanged

Whether the menu file has changed, usually meaning the user edited it.

FileInfo.nd

An index of the state of the files as of the last parse.

FileInfoFile, NaturalDocs::Project

sub FileInfoFile

Returns the full path to the file information file.

FILEINFOFILEHANDLE, NaturalDocs::Project

The file handle for the file information file, FileInfo.nd.

FileIsComment, NaturalDocs::Languages::Simple

sub FileIsComment

Returns whether the entire file should be treated as one big comment.

files

NaturalDocs:: ClassHierarchy

NaturalDocs:: SymbolTable

my %files

A hash of the hierarchy information referenced by file.

my %files

A hash of all the files that define symbols and references in the project.

Files

NaturalDocs:: ClassHierarchy

NaturalDocs:: Menu

NaturalDocs:: Project

NaturalDocs:: Settings

NaturalDocs:: SymbolTable

FilesInMenu, NaturalDocs::Menu

sub FilesInMenu

Returns a hashref of all the files present in the menu.

filesToBuild, NaturalDocs::Project

my %filesToBuild

An existence hash of all the files that need to be built.

FilesToBuild, NaturalDocs::Project

sub FilesToBuild

Returns an existence hashref of the list of files to build.

$filesToParse

Global

NaturalDocs:: Project

my $filesToParse

my %filesToParse

An existence hash of all the files that need to be parsed.

FilesToParse, NaturalDocs::Project

sub FilesToParse

Returns an existence hashref of the list of files to parse.

filesToPurge, NaturalDocs::Project

my %filesToPurge

An existence hash of files that had Natural Docs content last time, but now either don’t exist or no longer have content.

FilesToPurge, NaturalDocs::Project

sub FilesToPurge

Returns an existence hashref of the list of files that had content last time, but now either don’t anymore or were deleted.

FilesWithContent, NaturalDocs::Project

sub FilesWithContent

Returns and existence hashref of the files that have Natural Docs content.

FindEndOfPrototype, NaturalDocs::Languages::Simple

sub FindEndOfPrototype #	(	stringRef,
		falsePositives,
		symbols	)

Returns the index of the end of an arbitrary prototype in a string.

FindFirstFile, NaturalDocs::Builder::HTMLBase

A function that finds and returns the first file entry in the menu, or undef if none.

FlagAutoTitleChanges, NaturalDocs::Menu

sub FlagAutoTitleChanges

Finds which files have auto-titles that changed and flags their groups for updating with MENU_GROUP_UPDATETITLES and MENU_GROUP_UPDATEORDER.

Flags, NaturalDocs::Menu::Entry

sub Flags

Returns the Menu Entry Flags.

FLAGS, NaturalDocs::Menu::Entry

Any Menu Entry Flags that apply.

footer, NaturalDocs::Menu

my $footer

The footer for the documentation.

Footer

Global

NaturalDocs:: Menu

The page footer.

sub Footer

Returns the footer of the documentation, or undef if none.

Format, NaturalDocs::Version

Version numbers are represented as major.minor.

FormatBody, NaturalDocs::Parser::Native

sub FormatBody #	(	commentLines,
		startingIndex, endingIndex,
		type	)

Converts the section body to NDMarkup.

FormatPrototype

NaturalDocs:: Languages:: Base

NaturalDocs:: Languages:: Pascal

NaturalDocs:: Languages:: PLSQL

NaturalDocs:: Languages:: Tcl

sub FormatPrototype #	(	type,
		prototype	)

Parses a prototype so that it can be formatted nicely in the output.

sub FormatPrototype #	(	type,
		prototype	)

Pascal’s syntax allows directives after the prototype, separated by semicolons.

sub FormatPrototype #	(	type,
		prototype	)

Microsoft’s SQL implementation doesn’t require parenthesis.

sub FormatPrototype #	(	type,
		prototype	)

Tcl specifies parameters as a space-separated list in braces.

FramedContentPage

A framed content page.

FramedIndexPage

A framed index page.

FramedMenuPage

A framed menu page.

FromBinaryFile, NaturalDocs::Version

sub FromBinaryFile #(fileHandle)

Retrieves a version number from a binary file.

FromString, NaturalDocs::Version

sub FromString #(string)

Converts a version string to a comparable integer.

FromTextFile, NaturalDocs::Version

sub FromTextFile #(fileHandle)

Retrieves a version number from a text file.

Function Order, NaturalDocs::Builder::Base

The functions in the build process will always be called in the following order.

FUNCTION_ENDERS, NaturalDocs::Languages::Simple

An arrayref of symbols that can end a function prototype.

FunctionEnders, NaturalDocs::Languages::Simple

sub FunctionEnders

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

functionListIgnoredHeadings, NaturalDocs::Parser::Native

my %functionListIgnoredHeadings

An existence hash of all the headings that prevent the parser from creating function list symbols.

Functions

NaturalDocs:: Builder

NaturalDocs:: ConfigFile

NaturalDocs:: Extensions

NaturalDocs:: Languages

NaturalDocs:: Languages:: Advanced

NaturalDocs:: Languages:: Advanced:: Scope

NaturalDocs:: Languages:: Advanced:: ScopeChange

NaturalDocs:: Languages:: Pascal

NaturalDocs:: Parser

NaturalDocs:: Parser:: ParsedTopic

NaturalDocs:: Project:: File

NaturalDocs:: Settings:: BuildTarget

NaturalDocs:: SymbolTable:: ReferenceTarget

NaturalDocs:: Topics

NaturalDocs:: Version