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 FromTextFile #( handle  fileHandle ) => VersionInt

Retrieves a VersionInt from a text file.

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

Returns a VersionInt created from the passed values.

sub GenerateAutoFileTitles #( forceAll )

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

sub GenerateCrashReport

Generates a report and returns the FileName it’s located at.

sub GenerateDirectoryNames #( hashref  inputHints, hashref  imageHints )

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

sub GenerateInterpretations #( referenceString )

Generates the list of interpretations for the passed reference.

sub GenerateRelativeInterpretations #( referenceString, symbol, singulars, package, score, dontUseFull )

Generates the list of relative interpretations for the passed reference and packages.

sub GenerateTimestampText

Generates timestampText from timestampCode with the current date.

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

Advances the position one place through general code.

sub GenericSkip #( indexRef, lineNumberRef, noRegExps )

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

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

sub GenericSkipUntilAfter #( indexRef, lineNumberRef, token, noRegExps, allowStringedClosingParens )

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

sub GetAllDefinitionsHashRef

Returns a hashref of all the definitions of this item.

sub GetAllItemsHashRef #( ExtensionID  extension ) => hashref

Returns a hashref of all the items defined for an extension.

sub GetAllSupportedFiles

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

sub GetAndSkipXMLTag #( indexRef, lineNumberRef )

Processes the XML tag at the current position, moves beyond it, and returns information about it.

sub GetAString16 # => string

Reads and returns an AString16 from the open file.

sub GetDefinition #(     ExtensionID  extension,     string  itemString,     FileName  file ) => NaturalDocs::SourceDB::ItemDefinition or bool

If the extension uses custom NaturalDocs::SourceDB::ItemDefinition classes, returns it for the passed definition or undef if it doesn’t exist.

sub GetDefinition #(     FileName  file ) => NaturalDocs::SourceDB::ItemDefinition or bool

Returns the NaturalDocs::SourceDB::ItemDefinition-derived object for the passed FileName, non-zero if it only tracks existence, or undef if there is no definition.

sub GetDefinition #(     ExtensionID  extension,     string  itemString ) => NaturalDocs::SourceDB::ItemDefinition

Returns the NaturalDocs::SourceDB::ItemDefinition-derived object for the passed item string or undef if there is none.

sub GetItem #( ExtensionID  extension, string  itemString ) => bool

Returns the NaturalDocs::SourceDB::Item-derived object for the passed ExtensionID and item string, or undef if there is none.

sub GetLine

Returns the next line containing content, or an empty array if none.

sub GetMenuSelectionHierarchy #(     FileName  sourceFile,     TopicType  indexType ) -> NaturalDocs::Menu::Entry[] selectionHierarchy

Finds the sequence of menu groups that contain the current selection.

sub GetReferenceTarget #( FileName  sourceFile, string  text ) => FileName

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

sub GetSummaryFromBody #( body )

Returns the summary text from the topic body.

sub GetSummaryFromDescriptionList #( description )

Returns the summary text from a description list entry.

sub GetUInt16 # => UInt16

Reads and returns a UInt16 from the open file.

sub GetUInt32 # => UInt32

Reads and returns a UInt32 from the open file.

sub GetUInt8 # => UInt8

Reads and returns a UInt8 from the open file.

sub GlobalDefinition

Returns the FileName 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 TopicType of the global definition, or undef if the symbol isn’t defined.

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.