sub HasMultipleFiles

If HasMultipleFiles() is true, returns an arrayref of NaturalDocs::SymbolTable::IndexElement objects.

sub File

Returns the FileName the target is defined in.

sub FilesInMenu

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

sub FilesToBuild

Returns an existence hashref of the FileNames to build.

sub FilesToParse

Returns an existence hashref of the FileNames to parse.

sub FilesToPurge

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

sub FilesWithContent

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

sub FindFirstFile

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

sub FindFirstSymbol #( string, symbols, index )

Searches a string for a number of symbols to see which appears first.

sub FindMenuSelection #(     FileName  sourceFile,     TopicType  indexType,     NaturalDocs::Menu:: Entry[]  hierarchyRef,     NaturalDocs::Menu:: Entry[]  entries ) -> bool hasSelection

A recursive function that deterimes if it or any of its sub-groups has the menu selection.

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, isList )

Converts the section body to NDMarkup.

sub FormatText #( string  text, bool  inParagraph )

Translates any inline tags or HTML codes to NDMarkup and returns it.

sub FromBinaryFile

Loads an ImageReferenceString or undef from NaturalDocs::BinaryFile and returns it.

sub FromBinaryFile #( FileHandle  fileHandle, flags  binaryFormatFlags, ReferenceType  type, flags  resolvingFlags )

Reads a ReferenceString or undef from the passed filehandle.

sub FromBinaryFile #( FileHandle  fileHandle )

Loads a SymbolString or undef from the filehandle and returns it.

sub FromBinaryFile #( handle  fileHandle ) => VersionInt

Retrieves a VersionInt from a binary file.

sub FromString #( string  string ) => VersionInt

Converts a version string to a VersionInt.

sub FromText #( string  textSymbol )

Extracts and returns a SymbolString from plain text.

sub FromValues #( int  major, int  minor, int  month, int  day, int  year ) => VersionInt

Returns a VersionInt created from the passed values.