sub BanAndUnbanIndexes

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

Returns the part of the prototype before the parameter list.

sub BeginBuild #( hasChanged )

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

sub BeginBuild #( hasChanged )

Creates the necessary subdirectories in the output directory.

Returns an arrayref of start/end symbol pairs that specify a block comment, or undef if none.

sub Body

Returns the topic’s body, formatted in NDMarkup.

sub BreakLists

Breaks list topics into individual topics.

Returns whether list topics should be broken into individual topics in the output.

sub BuildClassHierarchy #( file, symbol )

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

sub BuildClassHierarchyEntry #( file, symbol, style, link )

Builds and returns a single class hierarchy entry.

sub BuildContent #( sourceFile, parsedFile )

Builds and returns the main page content.

sub BuildEMailLink #( target, name )

Creates a HTML link to an e-mail address.

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.

sub BuildFooter #( bool  multiline )

Builds and returns the HTML footer for the page.

sub BuildImage #( sourceFile, mode, target, original )

Builds the HTML for an image.

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.

sub BuildIndexElement #(     NaturalDocs::SymbolTable:: IndexElement  element,     string  cssID,     SymbolString  symbol,     SymbolString  package,     bool  hasPackage ) => ( string, string )

Converts a NaturalDocs::SymbolTable::IndexElement to HTML and returns it.

sub BuildIndexLink #( string  text, SymbolString  symbol, SymbolString  package, FileName  file, TopicType  type, string  prototype, string  summary, string  style ) => ( string, string )

Builds and returns the HTML associated with an index link.

sub BuildIndexNavigationBar #( type, page, locations )

Builds a navigation bar for a page of the index.

sub BuildIndexPages #(     TopicType  type,     NaturalDocs::SymbolTable:: IndexElement[]  indexSections,     string  beginIndexPage,     string  endIndexPage,     string  beginSearchResultsPage,     string  endSearchResultsPage ) => int

Builds an index file or files.

sub BuildIndexSections #(     NaturalDocs::SymbolTable:: IndexElement[]  index ) => ( string[], string[], string[] )

Builds and returns the index and search results sections in HTML.

sub BuildMenu #( FileName  sourceFile, TopicType  indexType ) -> string htmlMenu

Builds and returns the side menu of a file.

sub BuildMenuSegment #( outputDirectory, menuSegment, topLevel )

A recursive function to build a segment of the menu.

sub BuildPrototype #( type, prototype, file )

Builds and returns the prototype as HTML.

sub BuildSummary #( sourceFile, parsedFile, index )

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

sub BuildTargets

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

sub BuildTextLink #( target, name, original, package, using, sourceFile )

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

sub BuildTitle #( sourceFile )

Builds and returns the HTML page title of a file.

sub BuildToolTip #( symbol, file, type, prototype, summary )

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

sub BuildToolTipLinkProperties #( toolTipID )

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

sub BuildToolTips

Builds and returns the tooltips for the page in HTML.

sub BuildURLLink #( target, name )

Creates a HTML link to an external URL.