Function 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

T
	TabLength, NaturalDocs::Settings
	TagType, NaturalDocs::Parser::Native
	Target NaturalDocs::ImageReferenceTable::Reference NaturalDocs::Menu::Entry
	TextAppVersion, NaturalDocs::Settings
	TimeStamp, NaturalDocs::Menu
	Title NaturalDocs::Menu NaturalDocs::Menu::Entry NaturalDocs::Parser::ParsedTopic
	ToBinaryFile NaturalDocs::ImageReferenceTable::String NaturalDocs::ReferenceString NaturalDocs::SymbolString NaturalDocs::Version
	Toggle, SearchResults
	TokenizeLine, NaturalDocs::Languages::Advanced
	Tokens, NaturalDocs::Languages::Advanced
	ToString, NaturalDocs::Version
	ToText, NaturalDocs::SymbolString
	ToTextFile, NaturalDocs::Version
	ToValues, NaturalDocs::Version
	TryToGetBase, NaturalDocs::Languages::Perl
	TryToGetClass NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp
	TryToGetEnum, NaturalDocs::Languages::CSharp
	TryToGetFunction NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl
	TryToGetIdentifier, NaturalDocs::Languages::ActionScript
	TryToGetImport, NaturalDocs::Languages::ActionScript
	TryToGetListOfStrings, NaturalDocs::Languages::Perl
	TryToGetNamespace, NaturalDocs::Languages::CSharp
	TryToGetOverloadedOperator, NaturalDocs::Languages::CSharp
	TryToGetPackage, NaturalDocs::Languages::Perl
	TryToGetType, NaturalDocs::Languages::CSharp
	TryToGetUsing, NaturalDocs::Languages::CSharp
	TryToGetVariable NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl
	TryToGetVariableName, NaturalDocs::Languages::Perl
	TryToSkipAttributes, NaturalDocs::Languages::CSharp
	TryToSkipComment NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl
	TryToSkipHereDocContent, NaturalDocs::Languages::Perl
	TryToSkipHereDocDeclaration, NaturalDocs::Languages::Perl
	TryToSkipIrregularXML, NaturalDocs::Languages::ActionScript
	TryToSkipLineComment NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl
	TryToSkipMultilineComment NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp
	TryToSkipPODComment, NaturalDocs::Languages::Perl
	TryToSkipPreprocessingDirective, NaturalDocs::Languages::CSharp
	TryToSkipRegexp, NaturalDocs::Languages::Perl
	TryToSkipRegExp, NaturalDocs::Languages::ActionScript
	TryToSkipString NaturalDocs::Languages::ActionScript NaturalDocs::Languages::Advanced NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl
	TryToSkipWhitespace NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl
	TryToSkipXML, NaturalDocs::Languages::ActionScript
	TryToSkipXMLWhitespace, NaturalDocs::Languages::ActionScript
	Type NaturalDocs::Languages::Prototype::Parameter NaturalDocs::Menu::Entry NaturalDocs::Parser::ParsedTopic NaturalDocs::SymbolTable::IndexElement NaturalDocs::SymbolTable::ReferenceTarget NaturalDocs::SymbolTable::SymbolDefinition
	TypeBeforeParameter NaturalDocs::Languages::ActionScript NaturalDocs::Languages::Ada NaturalDocs::Languages::Base NaturalDocs::Languages::Pascal NaturalDocs::Languages::PLSQL
	TypeDefinedIn, NaturalDocs::SymbolTable::Symbol
	TypeFromLegacy, NaturalDocs::Topics
	TypeFromName, NaturalDocs::Topics
	TypeInfo, NaturalDocs::Topics
	TypeOf, NaturalDocs::ReferenceString
	TypePrefix, NaturalDocs::Languages::Prototype::Parameter

sub TabLength

Returns the number of spaces tabs should be expanded to.

sub TagType #( textBlocks,
index )

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

Returns the image FileName this reference resolves to, or undef if none.

sub Target

Returns the target of the entry, if applicable.

sub TextAppVersion

Returns Natural Docs’ version number as plain text.

sub TimeStamp

Returns the timestamp text of the documentation, or undef if none.

sub Title

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

sub Title

Returns the title of the entry.

sub Title

Returns the title of the topic.

sub ToBinaryFile #( ImageReferenceString referenceString )

Writes an ImageReferenceString to NaturalDocs::BinaryFile.

sub ToBinaryFile #( FileHandle fileHandle,
ReferenceString referenceString,
flags binaryFormatFlags )

Writes a ReferenceString to the passed filehandle.

sub ToBinaryFile #( FileHandle fileHandle,
SymbolString symbol )

Writes a SymbolString to the passed filehandle.

sub ToBinaryFile #( handle fileHandle,
VersionInt version )

Writes a VersionInt to a binary file.

this.Toggle = function( id )

Toggles the visibility of the passed element ID.

sub TokenizeLine #( line )

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

sub Tokens

Returns the tokens found by ParseForCommentsAndTokens().

sub ToString #( VersionInt version ) => string

Converts a VersionInt to a string.

sub ToText #( SymbolString symbolString,
string separator )

Converts a SymbolString to text, using the passed separator.

sub ToTextFile #( handle fileHandle,
VersionInt version )

Writes a VersionInt to a text file.

sub ToValues #( VersionInt version ) => ( int, int, int, int, int )

Converts a VersionInt to the array ( major, minor, month, day, year ).

sub TryToGetBase #( indexRef,
lineNumberRef )

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

sub TryToGetClass #( indexRef,
lineNumberRef )

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

sub TryToGetClass #( indexRef,
lineNumberRef )

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

sub TryToGetEnum #( indexRef,
lineNumberRef )

Determines if the position is on an enum declaration statement, and if so, generates a topic for it.

sub TryToGetFunction #( indexRef,
lineNumberRef )

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

sub TryToGetFunction #( indexRef,
lineNumberRef )

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

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.

sub TryToGetIdentifier #( indexRef,
lineNumberRef,
allowStar )

Determines whether the position is at an identifier, and if so, skips it and returns the complete identifier as a string.

sub TryToGetImport #( indexRef,
lineNumberRef )

Determines whether the position is at a import statement, and if so, adds it as a Using statement to the current scope, skips it, and returns true.

sub TryToGetListOfStrings #( indexRef,
lineNumberRef )

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

sub TryToGetNamespace #( indexRef,
lineNumberRef )

Determines whether the position is at a namespace declaration statement, and if so, adjusts the scope, skips it, and returns true.

sub TryToGetOverloadedOperator #( indexRef,
lineNumberRef )

Determines if the position is on an operator overload declaration, and if so, generates a topic for it, skips it, and returns true.

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.

sub TryToGetType #( indexRef,
lineNumberRef )

Determines if the position is on a type identifier, and if so, skips it and returns it as a string.

sub TryToGetUsing #( indexRef,
lineNumberRef )

Determines whether the position is at a using statement, and if so, adds it to the current scope, skips it, and returns true.

sub TryToGetVariable #( indexRef,
lineNumberRef )

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

sub TryToGetVariable #( indexRef,
lineNumberRef )

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

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.

sub TryToGetVariableName #( indexRef,
lineNumberRef )

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

sub TryToSkipAttributes #( indexRef,
lineNumberRef )

If the current position is on an attribute section, skip it and return true.

sub TryToSkipComment #( indexRef,
lineNumberRef )

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

sub TryToSkipComment #( indexRef,
lineNumberRef )

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

sub TryToSkipComment #( indexRef,
lineNumberRef )

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

sub TryToSkipHereDocContent #( indexRef,
lineNumberRef )

If the current position is at the beginning of a line and there are entries in hereDocTerminators, skips lines until all the terminators are exhausted or we reach the end of the file.

sub TryToSkipHereDocDeclaration #( indexRef,
lineNumberRef )

If the current position is on a Here Doc declaration, add its terminators to hereDocTerminators and skip it.

sub TryToSkipIrregularXML #( indexRef,
lineNumberRef )

If the current position is on an irregular XML tag, skip past it and return true.

sub TryToSkipLineComment #( indexRef,
lineNumberRef )

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

sub TryToSkipLineComment #( indexRef,
lineNumberRef )

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

sub TryToSkipLineComment #( indexRef,
lineNumberRef )

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

sub TryToSkipMultilineComment #( indexRef,
lineNumberRef )

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

sub TryToSkipMultilineComment #( indexRef,
lineNumberRef )

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

sub TryToSkipPODComment #( indexRef,
lineNumberRef )

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

sub TryToSkipPreprocessingDirective #( indexRef,
lineNumberRef )

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

sub TryToSkipRegexp #( indexRef,
lineNumberRef )

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

sub TryToSkipRegExp #( indexRef,
lineNumberRef )

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

sub TryToSkipString #( indexRef,
lineNumberRef )

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

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 )

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

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

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

sub TryToSkipWhitespace #( indexRef,
lineNumberRef )

If the current position is on a whitespace token, a line break token, or a comment, it skips them and returns true.

sub TryToSkipWhitespace #( indexRef,
lineNumberRef )

If the current position is on a whitespace token, a line break token, a comment, or a preprocessing directive, it skips them and returns true.

sub TryToSkipWhitespace #( indexRef,
lineNumberRef )

If the current position is on whitespace it skips them and returns true.

sub TryToSkipXML #( indexRef,
lineNumberRef )

If the current position is on an XML literal, skip past it and return true.

sub TryToSkipXMLWhitespace #( indexRef,
lineNumberRef )

If the current position is on XML whitespace, skip past it and return true.

The parameter type, if any.

sub Type

Returns the MenuEntryType.

sub Type

Returns the TopicType.

Returns the TopicType of the package/symbol/file, if applicable.

sub Type

Returns the target’s TopicType.

sub Type

Returns the definition’s TopicType.

sub TypeBeforeParameter

Returns whether the type appears before the parameter in prototypes.

sub TypeBeforeParameter

Returns whether the type appears before the parameter in prototypes.

sub TypeBeforeParameter

sub TypeDefinedIn #( file )

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

sub TypeFromLegacy #( legacyInt )

Returns a TopicType for the passed legacy topic type integer.

sub TypeFromName #( topicName )

Returns a TopicType for the passed topic name.

sub TypeInfo #( type )

Returns information about a TopicType.

sub TypeOf #( ReferenceString referenceString )

Returns the ReferenceType encoded in the reference string.

The parameter type prefix, which should be aligned separately, if any.