sub RebuildAllIndexes

When called, it makes sure all indexes are listed as changed by IndexChanged(), regardless of whether they actually did or not.

sub RebuildData

Returns whether all data files should be ignored and rebuilt.

sub RebuildEverything

Adds all supported files to the list of files to build.

sub RebuildFile #( file )

Adds the file to the list of files to build.

sub RebuildFilesFor #( class, rebuildParents, rebuildSelf, rebuildChildren )

Calls NaturalDocs::Project->RebuildFile() for every file defining the passed class, its parents, and/or its children.

Returns the current number of references to this image file during this Natural Docs execution.

sub References #( type, symbol, scope, using, file, resolvingFlags ) or (referenceString, file)

Returns what the passed reference information resolve to, if anything.

sub References

Returns an array of all the ReferenceStrings defined in this file.

sub References

Returns an array of all the reference strings that can be interpreted as this symbol.

sub ReferencesAndScores

Returns a hash of all the references that can be interpreted as this symbol and their scores.

sub Register

Registers the package with NaturalDocs::SourceDB.

sub Register

Override this function to register the package with NaturalDocs::SourceDB->RegisterExtension().

sub RegisterExtension #( package  extension, bool  usesDefinitionObjects ) => ExtensionID

Registers a NaturalDocs::SourceDB::Extension-derived package and returns a unique ExtensionID for it.

sub RelativeImageDirectories

Returns an arrayref of relative image directories.

sub RelativeIndexFileOf #( type, page )

Returns the output file name of the index file, relative to other index files.

sub RemoveDeadFiles

Removes files from the menu that no longer exist or no longer have Natural Docs content.

sub RemoveDeadGroups

Removes groups with less than two entries.

sub RemoveEmptyTree #( path, limit )

Removes an empty directory tree.

sub RemoveIfDead #( groupEntry, parentGroupEntry, parentGroupIndex )

Checks a group and all its sub-groups for life and remove any that are dead.

sub RemoveLineExtender #( line )

If the passed line has a line extender, returns it without the extender or the line break that follows.

sub RemoveRemainingHeaderlessTopics

After MergeAutoTopics() is done, this function removes any remaining headerless topics from the file.

sub RepairPackages #( autoTopics, scopeRecord )

Recalculates the packages for all comment topics using the auto-topics and the scope record.

sub ReparseEverything

Adds all supported files to the list of files to parse.

sub ResetToolTips #( samePage )

Resets the ToolTip Package Variables for a new page.

sub ResolveFile #( relativePath, possibleBases, possibleBaseScores )

Tests a relative path against a list of directories.

sub ResolveInputDirectories #( inputDirectoryNames )

Detects if the input directories in the menu file match those in the command line, and if not, tries to resolve them.

sub ResolveRelativeInputDirectories

Resolves relative input directories to the input directories available.

sub ResortGroups #( forceAll )

Resorts all groups that have MENU_GROUP_UPDATEORDER set.

sub RestoreAmpChars #( text )

Restores all amp characters to their original state.

sub RestoreAmpChars #( string  text ) => string

Replaces entity characters in the string with their original characters and returns it.

sub RestoreAmpChars #( text )

Replaces NDMarkup amp chars with their original symbols.

sub RichFormatTextBlock #( text )

Applies rich NDMarkup formatting to a chunk of text.

sub Run

Runs the build process.