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.

sub Target

Returns the target of the entry, if applicable.

sub TextAppVersion

Returns Natural Docs’ version number as plain text.

sub Title

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

sub Title

Returns the title of the entry.

sub ToBinaryFile # ( fileHandle, version )

Writes a version string to a binary file.

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().

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

sub ToString #(integer)

Converts a version integer to a string.

sub ToTextFile # ( fileHandle, version )

Writes a version string to a text file.

sub TryToGetBase # ( indexRef, lineNumberRef )

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

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 TryToGetListOfStrings # ( indexRef, lineNumberRef )

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

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 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 TryToSkipComment # ( indexRef, lineNumberRef )

If the current position is on a comment, 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 TryToSkipPODComment # ( indexRef, lineNumberRef )

If the current position is on a POD comment symbol, 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 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.

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.

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.

sub TypeDefinedIn #(file)

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

sub UnbuiltFilesWithContent

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

sub Unobscure #(text)

Restores text encoded with Obscure() and returns it.

sub UpdateFile #(sourceFile)

Updates an output file.

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 UseDirectory # ( directory, directory, directory ... )

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

sub VariableEnders

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

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.

sub WriteMenuEntries # ( entries, fileHandle, indentChars )

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 XChomp #(lineRef)

A cross-platform chomp function.