sub BanAndUnbanIndexes

Adjusts the indexes that are banned depending on if the user added or deleted any.

If your extension requires any external packages that are not included in all Perl distributions by default, you must define BEGIN to call NaturalDocs::Extensions->Requires() for them instead of using ‘use [package]’ or ‘require [package]’ directly.

sub BeginBuild #(hasChanged)

Define this function if the package needs to do anything at the beginning of the build process.

sub Body

Returns the topic’s body, formatted in NDMarkup.

Returns the JavaScript necessary to detect the browser.

Builds and returns a class hierarchy diagram for the passed class, if applicable.

Builds and returns a single class hierarchy entry.

Builds and returns the main page content.

Creates a HTML link to an e-mail address.

sub Builder

Returns the NaturalDocs::Builder::Base-derived object for the target’s output format.

sub BuildFile # ( sourceFile, parsedFile )

Define this function to convert a parsed file to this package’s output format.

sub BuildFile # ( sourceFile, parsedFile )

Builds the output file from the parsed source file.

sub BuildFile # ( sourceFile, parsedFile )

Builds the output file from the parsed source file.

Builds and returns the HTML footer for the page.

sub BuildIndex #(topic)

Define this function to create an index for the passed topic.

sub BuildIndex #(type)

Builds an index for the passed type.

sub BuildIndex #(type)

Builds an index for the passed type.

Builds and returns index’s content in HTML.

Builds an index file or files.

Returns a link in the index, complete with surrounding IEntry tags.

Builds a navigation bar for a page of the index.

Creates a HTML link to a symbol, if it exists.

Builds and returns the side menu of a file.

A recursive function to build a segment of the menu.

Builds and returns the prototype as HTML.

Builds a summary, either for the entire file or the current class/section.

sub BuildTargets

Returns an arrayref of NaturalDocs::Settings::BuildTargets.

Builds and returns the HTML page title of a file.

Builds the HTML for a symbol’s tooltip and stores it in tooltipHTML.

Returns the properties that should go in the link tag to add a tooltip to it.

Builds and returns the tooltips for the page in HTML.

sub CanonizePath #(path)

Takes a path and returns a logically simplified version of it.

sub ChangeDefinition # ( file, type, prototype, summary )

Changes the information about an existing definition.

sub CheckCompatibility

Checks if the standard packages required by this one are up to snuff and dies if they aren’t.

sub CheckForTrashedMenu # ( numberOriginallyInMenu, numberRemoved )

Checks the menu to see if a significant number of file entries didn’t resolve to actual files, and if so, saves a backup of the menu and issues a warning.

sub Children

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

sub ChildrenOf #(class)

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

sub Class

Returns the class of the topic.

sub Class

Returns the class of the symbol, if applicable.

sub Class

Returns the target’s class, or undef if it’s global.

sub Classes

Returns an array of the classes that are defined by this file, or an empty array if none.

sub ClassHierarchyFile

Returns thhe full path to the class hierarchy’s data file.

sub CleanComment #(commentLines)

Removes any extraneous formatting and whitespace from the comment.

sub ClearAutoTopics

Resets the automatic topic list.

sub ClearScopeStack

Clears the scope stack for a new file.

sub ClearTokens

Resets the token list.

Returns the JavaScript that will close browser styles if necessary.

sub ClosingCommentSymbols

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

sub ClosingTag # ( textBlocks, index, hasWhitespace )

Returns whether a tag is closed or not, where it’s closed if it is, and optionally whether there is any whitespace between the tags.

sub CommandLineOption

Define this function to return the text that should be put in the command line after -o to use this package.

sub CommandLineOption

Returns the option to follow -o to use this package.

sub CommandLineOption

Returns the option to follow -o to use this package.

sub CommandLineOptions

Returns a hashref of the command line options by extension package.

sub CommandLineOptions

Use this function to return a hashref of all the command line options the extension accepts.

A comparison function for use in sorting.

sub ConstantOf #(string)

Returns the Topic Types associated with the string, or undef if none.

sub Content

Returns the parsed menu as an arrayref of NaturalDocs::Menu::Entry objects.

Converts certain characters to their HTML amp char equivalents.

sub ConvertAmpChars #(text)

Substitutes certain characters with their NDMarkup amp chars.

sub ConvertToURL #(path)

Takes a relative path and converts it from the native format to a relative URL.

sub Copy # ( source, destination )

Copies a file from one path to another.

Where possible, creates sub-groups based on directories for any long groups that have MENU_GROUP_UPDATESTRUCTURE set.

sub CreatePath #(path)

Creates a directory tree corresponding to the passed path, regardless of how many directories do or do not already exist.

sub CreateString # ( startIndex, endIndex )

Converts the specified tokens into a string and returns it.

sub CurrentInterpretation

Returns the symbol string of the current interpretation, or undef if none.

sub CurrentNamespace

Returns the current calculated namespace, or undef if none.

sub CurrentPackage

Returns the current calculated package or class, or undef if none.

sub CurrentProtection

Returns the current protection, or undef if none.

sub CurrentScope

Returns the current calculated scope, or undef if global.

sub CurrentScore

Returns the score of the current interpretation, or undef if none.