The FileName for the current configuration file being parsed.
my $file
If HasMultipleFiles() is true, returns an arrayref of NaturalDocs::SymbolTable::IndexElement objects.
sub HasMultipleFiles
Returns the FileName the target is defined in.
sub File
A hash of the hierarchy information referenced by file.
my %files
A hashref mapping source FileNames to NaturalDocs::SourceDB::Files.
my %files
A hash of all the files that define symbols and references in the project.
my %files
Returns a hashref of all the files present in the menu.
sub FilesInMenu
An existence hash of all the FileNames that need to be built.
my %filesToBuild
Returns an existence hashref of the FileNames to build.
sub FilesToBuild
An existence hash of all the FileNames that need to be parsed.
my %filesToParse
my $filesToParse
Returns an existence hashref of the FileNames to parse.
sub FilesToParse
An existence hash of the FileNames that had Natural Docs content last time, but now either don’t exist or no longer have content.
my %filesToPurge
Returns an existence hashref of the FileNames that had content last time, but now either don’t anymore or were deleted.
sub FilesToPurge
Returns and existence hashref of the FileNames that have Natural Docs content.
sub FilesWithContent
A function that finds and returns the first file entry in the menu, or undef if none.
sub FindFirstFile
Searches a string for a number of symbols to see which appears first.
sub FindFirstSymbol #( string, symbols, index )
A recursive function that deterimes if it or any of its sub-groups has the menu selection.
sub FindMenuSelection #( FileName sourceFile, TopicType indexType, NaturalDocs::Menu:: Entry[] hierarchyRef, NaturalDocs::Menu:: Entry[] entries ) -> bool hasSelection
Finds which files have auto-titles that changed and flags their groups for updating with MENU_GROUP_UPDATETITLES and MENU_GROUP_UPDATEORDER.
sub FlagAutoTitleChanges
Returns the Menu Entry Flags.
sub Flags
The footer for the documentation.
my $footer
Returns the footer of the documentation, or undef if none.
sub Footer
Converts the section body to NDMarkup.
sub FormatBody #( commentLines, startingIndex, endingIndex, type, isList )
Translates any inline tags or HTML codes to NDMarkup and returns it.
sub FormatText #( string text, bool inParagraph )
Loads an ImageReferenceString or undef from NaturalDocs::BinaryFile and returns it.
sub FromBinaryFile
Reads a ReferenceString or undef from the passed filehandle.
sub FromBinaryFile #( FileHandle fileHandle, flags binaryFormatFlags, ReferenceType type, flags resolvingFlags )
Loads a SymbolString or undef from the filehandle and returns it.
sub FromBinaryFile #( FileHandle fileHandle )
Retrieves a VersionInt from a binary file.
sub FromBinaryFile #( handle fileHandle ) => VersionInt
Converts a version string to a VersionInt.
sub FromString #( string string ) => VersionInt
Extracts and returns a SymbolString from plain text.
sub FromText #( string textSymbol )
Retrieves a VersionInt from a text file.
sub FromTextFile #( handle fileHandle ) => VersionInt
Returns a VersionInt created from the passed values.
sub FromValues #( int major, int minor, int month, int day, int year ) => VersionInt
An existence hash of all the headings that prevent the parser from creating function list symbols.
my %functionListIgnoredHeadings
An existence hash of all the acceptable function modifiers.
my %functionModifiers