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.

sub File

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

sub File

Returns the file the target is defined in.

sub FileInfoFile

Returns the full path to the file information file.

sub FileIsComment

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

sub FilesInMenu

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

sub FilesToBuild

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

sub FilesToParse

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

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.

sub FilesWithContent

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

sub FindEndOfPrototype # ( stringRef, falsePositives, symbols )

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

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

sub FlagAutoTitleChanges

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

sub Flags

Returns the Menu Entry Flags.

sub Footer

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

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

Converts the section body to NDMarkup.

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.

sub FromBinaryFile #(fileHandle)

Retrieves a version number from a binary file.

sub FromString #(string)

Converts a version string to a comparable integer.

sub FromTextFile #(fileHandle)

Retrieves a version number from a text file.

sub FunctionEnders

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

Creates titles for the unlocked file entries in all groups that have the MENU_GROUP_UPDATETITLES flag set.

sub GenerateDirectoryNames #(hints)

Generates names for each of the input directories, which can later be retrieved with InputDirectoryNameOf().

sub GenerateInterpretations # ( scope, reference )

Generates the list of interpretations for the passed reference.

sub GenerateSingularInterpretations #(symbol)

Generates singular interpretations of a symbol if it can be interpreted as a plural.

sub GenericRegexpSkip # ( indexRef, lineNumberRef, inBrackets )

Advances the position one place through regexp code.

sub GenericRegexpSkipUntilAfter # ( indexRef, lineNumberRef, token )

Advances the position via GenericRegexpSkip() until a specific token is reached and passed.

sub GenericSkip # ( indexRef, lineNumberRef )

Advances the position one place through general code.

sub GenericSkipUntilAfter # ( indexRef, lineNumberRef, token )

Advances the position via GenericSkip() until a specific token is reached and passed.

sub GetAllSupportedFiles

Gets all the supported files in the passed directory and its subdirectories and puts them into supportedFiles.

sub GlobalDefinition # ( class, symbol )

Returns the global definition of the passed symbol.

sub GlobalDefinition

Returns the file that contains the global definition of this symbol, or undef if the symbol isn’t defined.

sub GlobalPrototype

Returns the prototype of the global definition.

sub GlobalSummary

Returns the summary of the global definition.

sub GlobalType

Returns the type of the global definition.

sub GroupContent

Returns an arrayref of NaturalDocs::Menu::Entry objects representing the contents of the group, or undef otherwise.

sub GroupIsEmpty

If the type is MENU_GROUP, returns whether the group is empty.

sub HandleErrors

Handles any errors that we’re found in the configuration file, which currently means printing them out in the GNU error format and annotating the configuration file with error comments.

sub HasAnything

Returns whether the file has any symbol or reference definitions at all.

sub HasChanged

Returns whether the menu has changed or not.

sub HasChildren

Returns whether any child classes are defined.

sub HasClass #(class)

Returns whether the file defines the passed class.

sub HasContent #(file)

Returns whether the file contains Natural Docs content.

sub HasContent

Returns whether the file contains Natural Docs content or not.

sub HasCurrentInterpretation

Returns whether the reference has a current interpretation or not.

sub HasIndexes #(types)

Determines which indexes out of a list actually have content.

sub HasParent # ( class, parent )

Returns whether the file defines the passed class and parent.

sub HasParents

Returns whether any parent classes are defined.

sub HasPrototype #(type)

Returns whether the language accepts prototypes from the passed Topic Types.

sub HasReferences

Returns whether the symbol can be interpreted as any references.

sub HeadersOnly

Returns whether to only check the header files in C/C++.