Index - Natural Docs

sub BanAndUnbanIndexes

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

my %bannedIndexes

An existence hash of all the indexes that the user has manually deleted, and thus should not be added back to the menu automatically.

BEGIN, NaturalDocs::Extensions::Base

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.

BeginBuild, NaturalDocs::Builder::Base

sub BeginBuild #(hasChanged)

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

Binary File Format, NaturalDocs::Version

In binary files, versions are two 8-bit unsigned values, appearing major then minor.

BINARY_FORMAT, NaturalDocs::Constants

An 8-bit constant that’s used as the first byte of binary data files.

Body, NaturalDocs::Parser::ParsedTopic

sub Body

Returns the topic’s body, formatted in NDMarkup.

BODY, NaturalDocs::Parser::ParsedTopic

The body of the topic, formatted in NDMarkup.

Browser Styles

Natural Docs pages include JavaScript to detect which browser the user is running and apply styles so that you can work around browser quirks right in the CSS file.

BrowserStylesJavaScript, NaturalDocs::Builder::HTMLBase

Returns the JavaScript necessary to detect the browser.

BuildClassHierarchy, NaturalDocs::Builder::HTMLBase

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

BuildClassHierarchyEntry, NaturalDocs::Builder::HTMLBase

Builds and returns a single class hierarchy entry.

BuildContent, NaturalDocs::Builder::HTMLBase

Builds and returns the main page content.

BuildEMailLink, NaturalDocs::Builder::HTMLBase

Creates a HTML link to an e-mail address.

Builder, NaturalDocs::Settings::BuildTarget

sub Builder

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

BUILDER, NaturalDocs::Settings::BuildTarget

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

BuildFile

NaturalDocs:: Builder:: Base

NaturalDocs:: Builder:: FramedHTML

NaturalDocs:: Builder:: HTML

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.

BuildFooter, NaturalDocs::Builder::HTMLBase

Builds and returns the HTML footer for the page.

BuildIndex

NaturalDocs:: Builder:: Base

NaturalDocs:: Builder:: FramedHTML

NaturalDocs:: Builder:: HTML

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.

BuildIndexContent, NaturalDocs::Builder::HTMLBase

Builds and returns index’s content in HTML.

BuildIndexFiles, NaturalDocs::Builder::HTMLBase

Builds an index file or files.

BuildIndexLink, NaturalDocs::Builder::HTMLBase

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

BuildIndexNavigationBar, NaturalDocs::Builder::HTMLBase

Builds a navigation bar for a page of the index.

BuildLink, NaturalDocs::Builder::HTMLBase

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

BuildMenu, NaturalDocs::Builder::HTMLBase

Builds and returns the side menu of a file.

BuildMenuSegment, NaturalDocs::Builder::HTMLBase

A recursive function to build a segment of the menu.

BuildPrototype, NaturalDocs::Builder::HTMLBase

Builds and returns the prototype as HTML.

BuildSummary, NaturalDocs::Builder::HTMLBase

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

buildTargets, NaturalDocs::Settings

my @buildTargets

An array of NaturalDocs::Settings::BuildTargets.

BuildTargets, NaturalDocs::Settings

sub BuildTargets

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

BuildTitle, NaturalDocs::Builder::HTMLBase

Builds and returns the HTML page title of a file.

BuildToolTip, NaturalDocs::Builder::HTMLBase

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

BuildToolTipLinkProperties, NaturalDocs::Builder::HTMLBase

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

BuildToolTips, NaturalDocs::Builder::HTMLBase

Builds and returns the tooltips for the page in HTML.