sub Obscure #(text)

Obscures the passed text so that it is not user editable and returns it.

sub OnClass #(class)

A function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a class declaration.

sub OnClassParent # ( class, parent, protection )

A function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a declaration of inheritance.

sub OnCode # ( codeLines, codeLineNumber, topicList, lastCommentTopicCount )

Called whenever a section of code is encountered by the parser.

sub OnComment # ( commentLines, lineNumber )

The function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a comment suitable for documentation.

sub OnDefaultTitleChange #(file)

Called by NaturalDocs::Project if the default menu title of a source file has changed.

sub OnFileChange

Called by NaturalDocs::Project if it detects that the menu file has changed.

Returns the JavaScript that will add opening browser styles if necessary.

sub OpeningCommentSymbols

Returns an arrayref of symbols used to start a multi-line comment, or undef if none.

sub OutputDirectoryOf #(object)

Returns the output directory of a builder object.

Returns the output file name of the source file.

sub OutputPackageOf #(commandLineOption)

Returns the output package corresponding to the passed command line option, or undef if none.

sub OutputPackages

Returns an arrayref of the output packages available for use.

sub OutputStyleOf #(object)

Returns the style associated with a builder object.

sub Package

Returns the package or class of the scope, or undef if none.

sub ParentDefinitions #(parent)

Returns an array of all the files that define the parent as part of the class, or an empty array if none.

sub Parents

Returns an array of the parent classes, or an empty array if none.

sub ParentsOf #(class)

Returns an array of the passed class’ parents, or an empty array if none.

sub ParentsOf #(class)

Returns an array of the parents that are defined by the class, or an empty array if none.

sub Parse

Opens the source file and parses process.

sub ParseCommandLine

Parses and validates the command line.

sub ParseCommandLineOptions #(options)

Sends the command line options to their extensions.

sub ParseCommandLineOptions #(options)

This is called after the command line has been parsed.

sub ParseComment # ( commentLines, lineNumber, parsedTopics )

This will be called whenever a comment capable of containing Natural Docs content is found.

Parses the passed source file, sending comments acceptable for documentation to NaturalDocs::Parser->OnComment().

sub ParseFile # ( sourceFile, topicsList )

Parses the passed source file, sending comments acceptable for documentation to NaturalDocs::Parser->OnComment().

sub ParseFile # ( sourceFile, topicsList )

Parses the passed source file, sending comments acceptable for documentation to NaturalDocs::Parser->OnComment() and all other sections to OnCode().

sub ParseForBuild #(file)

Parses the input file for building, returning it as a NaturalDocs::Parser::ParsedTopic arrayref.

sub ParseForCommentsAndTokens # ( sourceFile, lineCommentSymbols, openingCommentSymbols, closingCommentSymbols )

Loads the passed file, sends all appropriate comments to NaturalDocs::Parser->OnComment(), and breaks the rest into an arrayref of tokens.

sub ParseForInformation #(file)

Parses the input file for information.

sub PathIsAbsolute #(path)

Returns whether the passed path is absolute.

sub PluralNameOf #(topic)

Returns the plural name string of the passed constant.

sub PreparePrototype #(prototype)

Converts a prototype string for internal use.

sub PrepareString #(string)

Takes a symbol, reference, class, or scope and removes any minor features that could interfere with matching.

sub PreviousIndexes

Returns an existence hashref of all the indexes that previously appeared in the menu.

sub PreviousMenuStateFile

Returns the full path to the project’s previous menu state file.

sub PreviousSettingsFile

Returns the full path to the project’s previous settings file.

sub PrintOutputFormats #(prefix)

Prints all the possible output formats that can be specified with -o.

sub PrintSyntax

Prints the syntax reference.

sub ProjectDataDirectory

Returns the project data directory.

sub ProjectDirectory

Returns the project directory.

sub Protection

Returns the protection of the scope, such as public/private/protected.

sub Prototype

Returns the prototype if Type() is TOPIC_FUNCTION or TOPIC_VARIABLE and one is defined.

sub Prototype

Returns the prototype of the class/symbol/file, if applicable.

sub Prototype

Returns the target’s prototype, or undef if not defined or not applicable.

sub Prototype

Returns the definition’s prototype, or undef if it doesn’t have one.

sub PrototypeDefinedIn #(file)

Returns the prototype of symbol defined in the passed file, or undef if it doesn’t exist or is not defined in that file.

sub Purge

Purges the hierarchy of files that no longer have Natural Docs content.

sub Purge

Purges the symbol table of all symbols and references from files that no longer have Natural Docs content.

sub PurgeFiles #(files)

Define this function to make the package remove all output related to the passed files.

sub PurgeFiles

Deletes the output files associated with the purged source files.

sub PurgeIndexes #(indexes)

Define this function to make the package remove all output related to the passed indexes.

sub PurgeIndexes #(indexes)

Deletes the output files associated with the purged source files.

sub PurgeIndexes

Clears all generated indexes.

Removes all or some of the output files for an index.

sub PurgeResolvingInfo

Purges unnecessary information from the symbol table after it is fully resolved.

sub PushToGroup #(entry)

Pushes the entry to the end of the group content.

sub RebuildData

Returns whether the script should rebuild all data files from scratch.

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 RebuildOutput

Returns whether the script should rebuild all output files from scratch.

sub References # ( scope, reference, file )

Returns what the passed symbol and scope reference, if anything.

sub References

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

sub References

Returns an array of all the references 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.

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.

Removes groups with less than two entries.

sub RemoveExtenders #(stringRef)

Strips any LineExtender() symbols out of the prototype.

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

sub RepairScope # ( autoTopics, scopeRecord )

Recalculates the scope 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 Requires # ( extension, requirement, requirement, requirement ... )

Adds external packages similar to if you used the line ‘require [package]’.

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 pre-1.16 relative input directories to the input directories available.

Resorts all groups that have MENU_GROUP_UPDATEORDER set.

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.