Index - Natural Docs

tabLength, NaturalDocs::Settings

my $tabLength

The number of spaces in tabs.

TabLength, NaturalDocs::Settings

sub TabLength

Returns the number of spaces tabs should be expanded to.

Tabs

NDMarkup will not contain tab characters, only spaces.

TagType, NaturalDocs::Parser::Native

sub TagType #	(	textBlocks,
		index	)

Returns whether the tag is a possible opening or closing tag, or neither.

Target, NaturalDocs::Menu::Entry

sub Target

Returns the target of the entry, if applicable.

TARGET, NaturalDocs::Menu::Entry

The target of the entry.

Text File Format, NaturalDocs::Version

In text files, versions are the String Format followed by a native line break.

Text Tags

These tags will only appear in paragraphs, headings, or description list descriptions.

TextAppVersion, NaturalDocs::Settings

sub TextAppVersion

Returns Natural Docs’ version number as plain text.

title, NaturalDocs::Menu

my $title

The title of the menu.

Title

NaturalDocs:: Menu

NaturalDocs:: Menu:: Entry

sub Title

Returns the title of the menu, or undef if none.

sub Title

Returns the title of the entry.

TITLE, NaturalDocs::Menu::Entry

The title of the entry.

ToBinaryFile, NaturalDocs::Version

sub ToBinaryFile #	(	fileHandle,
		version	)

Writes a version string to a binary file.

TokenizeLine, NaturalDocs::Languages::Advanced

sub TokenizeLine #(line)

Converts the passed line to tokens as described in ParseForCommentsAndTokens and adds them to Tokens().

Tokens, NaturalDocs::Languages::Advanced

sub Tokens

Returns the tokens found by ParseForCommentsAndTokens().

TOKENS, NaturalDocs::Languages::Advanced

An arrayref of tokens used in all the Parsing Functions.

Tool Tip Structure

hidden.

Tool Tip Styles

ToolTip Package Variables, NaturalDocs::Builder::HTMLBase

These variables are for the tooltip generation functions only.

tooltipHTML, NaturalDocs::Builder::HTMLBase

my $tooltipHTML

The generated tooltip HTML.

tooltipLinkNumber, NaturalDocs::Builder::HTMLBase

my $tooltipLinkNumber

A number used as part of the ID for each link that has a tooltip.

tooltipNumber, NaturalDocs::Builder::HTMLBase

my $tooltipNumber

A number used as part of the ID for each tooltip.

ToolTipsJavaScript, NaturalDocs::Builder::HTMLBase

Returns the JavaScript necessary to show, hide, and position tool tips.

tooltipSymbolsToNumbers, NaturalDocs::Builder::HTMLBase

my %tooltipSymbolsToNumbers

A hash that maps the tooltip symbols to their assigned numbers.

Top-Level Tags

All content will be surrounded by one of the top-level tags.

Topic Types

NaturalDocs:: Constants

NaturalDocs:: Topics

See NaturalDocs::Topics::Topic Types.

Constants representing all the types of Natural Docs sections.

TOPIC_CLASS, NaturalDocs::Topics

A class.

TOPIC_CLASS_LIST, NaturalDocs::Topics

A list of classes.

TOPIC_CONSTANT, NaturalDocs::Topics

A constant.

TOPIC_CONSTANT_LIST, NaturalDocs::Topics

A list of constants.

TOPIC_FILE, NaturalDocs::Topics

A file.

TOPIC_FILE_LIST, NaturalDocs::Topics

A list of files.

TOPIC_FUNCTION, NaturalDocs::Topics

A function.

TOPIC_FUNCTION_LIST, NaturalDocs::Topics

A list of functions.

TOPIC_GENERIC, NaturalDocs::Topics

A generic topic.

TOPIC_GENERIC_LIST, NaturalDocs::Topics

A list of generic topics.

TOPIC_GROUP, NaturalDocs::Topics

A subdivider for long lists.

TOPIC_SECTION, NaturalDocs::Topics

A main section of code or text.

TOPIC_TYPE, NaturalDocs::Topics

A type.

TOPIC_TYPE_LIST, NaturalDocs::Topics

A list of types.

TOPIC_VARIABLE, NaturalDocs::Topics

A variable.

TOPIC_VARIABLE_LIST, NaturalDocs::Topics

A list of variables.

ToString, NaturalDocs::Version

sub ToString #(integer)

Converts a version integer to a string.

ToTextFile, NaturalDocs::Version

sub ToTextFile #	(	fileHandle,
		version	)

Writes a version string to a text file.

TryToGetBase, NaturalDocs::Languages::Perl

sub TryToGetBase #	(	indexRef,
		lineNumberRef	)

Determines whether the position is at a package base declaration statement, and if so, calls NaturalDocs::Parser->OnParent().

TryToGetFunction, NaturalDocs::Languages::Perl

sub TryToGetFunction #	(	indexRef,
		lineNumberRef	)

Determines whether the position is at a function declaration statement, and if so, generates a topic for it, skips it, and returns true.

TryToGetListOfStrings, NaturalDocs::Languages::Perl

sub TryToGetListOfStrings #	(	indexRef,
		lineNumberRef	)

Attempts to retrieve a list of strings from the current position.

TryToGetPackage, NaturalDocs::Languages::Perl

sub TryToGetPackage #	(	indexRef,
		lineNumberRef	)

Determines whether the position is at a package declaration statement, and if so, generates a topic for it, skips it, and returns true.

TryToGetVariable, NaturalDocs::Languages::Perl

sub TryToGetVariable #	(	indexRef,
		lineNumberRef	)

Determines if the position is at a variable declaration statement, and if so, generates a topic for it, skips it, and returns true.

TryToGetVariableName, NaturalDocs::Languages::Perl

sub TryToGetVariableName #	(	indexRef,
		lineNumberRef	)

Determines if the position is at a variable name, and if so, skips it and returns the name.

TryToSkipComment, NaturalDocs::Languages::Perl

sub TryToSkipComment #	(	indexRef,
		lineNumberRef	)

If the current position is on a comment, skip past it and return true.

TryToSkipLineComment, NaturalDocs::Languages::Perl

sub TryToSkipLineComment #	(	indexRef,
		lineNumberRef	)

If the current position is on a line comment symbol, skip past it and return true.

TryToSkipPODComment, NaturalDocs::Languages::Perl

sub TryToSkipPODComment #	(	indexRef,
		lineNumberRef	)

If the current position is on a POD comment symbol, skip past it and return true.

TryToSkipRegexp, NaturalDocs::Languages::Perl

sub TryToSkipRegexp #	(	indexRef,
		lineNumberRef	)

If the current position is on a regular expression or a quote-like operator, skip past it and return true.

TryToSkipString

NaturalDocs:: Languages:: Advanced

NaturalDocs:: Languages:: Perl

sub TryToSkipString #	(	indexRef,
		lineNumberRef, openingDelimiter, closingDelimiter, startContentIndexRef,
		endContentIndexRef	)

If the position is on a string delimiter, moves the position to the token following the closing delimiter, or past the end of the tokens if there is none.

sub TryToSkipString #	(	indexRef,
		lineNumberRef, startContentIndexRef,
		endContentIndexRef	)

If the current position is on a string delimiter, skip past the string and return true.

TryToSkipWhitespace, NaturalDocs::Languages::Perl

sub TryToSkipWhitespace #	(	indexRef,
		lineNumberRef	)

If the current position is on a whitespace or line break token, skip all line breaks and whitespace and return true.

Type

NaturalDocs:: Menu:: Entry

NaturalDocs:: Parser:: ParsedTopic

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: ReferenceTarget

NaturalDocs:: SymbolTable:: SymbolDefinition

sub Type

Returns the type of the entry.

sub Type

Returns the type of the topic.

sub Type

Returns the type of the class/symbol/file, if applicable.

sub Type

Returns the target’s type.

sub Type

Returns the definition’s type.

TYPE

NaturalDocs:: Menu:: Entry

NaturalDocs:: Parser:: ParsedTopic

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: ReferenceTarget

NaturalDocs:: SymbolTable:: SymbolDefinition

The type of entry.

The type of the topic.

The class/symbol/file type.

The target type.

The symbol type.

TypeDefinedIn, NaturalDocs::SymbolTable::Symbol

sub TypeDefinedIn #(file)

Returns the type of symbol defined in the passed file, or undef if it’s not defined in that file.