Index - Natural Docs

Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

B
	BanAndUnbanIndexes, NaturalDocs::Menu
	bannedIndexes, NaturalDocs::Menu
	Basic File Processing
	Basic Types
	BeforeParameters, NaturalDocs::Languages::Prototype
	BeginBuild NaturalDocs::Builder::Base NaturalDocs::Builder::HTMLBase
	Binary File Format, NaturalDocs::Version
	Binary Format Flags
	BINARY_FORMAT
NaturalDocs::	BinaryFile
	BINARYREF_NORESOLVEFLAGS
	BINARYREF_NOTYPE
	BlockCommentSymbols, NaturalDocs::Languages::Simple
	blockquote
	blockTags, NaturalDocs::Parser::JavaDoc
	Body, NaturalDocs::Parser::ParsedTopic
	BODY
$	bold, NaturalDocs::Parser::Native
	BREAK_LISTS
	BreakLists NaturalDocs::Parser NaturalDocs::Topics::Type
	Browser Styles
	Browser Testing
	Browsers
	BuildClassHierarchy, NaturalDocs::Builder::HTMLBase
	BuildClassHierarchyEntry, NaturalDocs::Builder::HTMLBase
	BuildContent, NaturalDocs::Builder::HTMLBase
	BuildEMailLink, NaturalDocs::Builder::HTMLBase
	Builder, NaturalDocs::Settings::BuildTarget
NaturalDocs::	Builder
	BUILDER
NaturalDocs::	Builder::Base
NaturalDocs::	Builder::FramedHTML
NaturalDocs::	Builder::HTML
NaturalDocs::	Builder::HTMLBase
	BuildFile NaturalDocs::Builder::Base NaturalDocs::Builder::FramedHTML NaturalDocs::Builder::HTML
	BuildFooter, NaturalDocs::Builder::HTMLBase
	BuildImage, NaturalDocs::Builder::HTMLBase
	BuildIndex NaturalDocs::Builder::Base NaturalDocs::Builder::FramedHTML NaturalDocs::Builder::HTML
	BuildIndexElement, NaturalDocs::Builder::HTMLBase
	BuildIndexLink, NaturalDocs::Builder::HTMLBase
	BuildIndexNavigationBar, NaturalDocs::Builder::HTMLBase
	BuildIndexPages, NaturalDocs::Builder::HTMLBase
	BuildIndexSections, NaturalDocs::Builder::HTMLBase
	BuildMenu, NaturalDocs::Builder::HTMLBase
	BuildMenuSegment, NaturalDocs::Builder::HTMLBase
	BuildPrototype, NaturalDocs::Builder::HTMLBase
	BuildSummary, NaturalDocs::Builder::HTMLBase
	buildTargets, NaturalDocs::Settings
	BuildTargets, NaturalDocs::Settings
	BuildTextLink, NaturalDocs::Builder::HTMLBase
	BuildTitle, NaturalDocs::Builder::HTMLBase
	BuildToolTip, NaturalDocs::Builder::HTMLBase
	BuildToolTipLinkProperties, NaturalDocs::Builder::HTMLBase
	BuildToolTips, NaturalDocs::Builder::HTMLBase
	BuildURLLink, NaturalDocs::Builder::HTMLBase

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 index TopicTypes that the user has manually deleted, and thus should not be added back to the menu automatically.

The nitty-gritty file handling is no longer done in NaturalDocs::Parser itself due to the introduction of full language support in 1.3, as it required two completely different code paths for full and basic language support.

Types used throughout the program.

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.

Five 8-bit unsigned values, appearing major, minor, month, day, year.

These flags can be combined to specify the format when using ToBinaryFile() and FromBinaryFile().

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

A package to manage Natural Docs’ binary data files.

Do not include the Resolving Flags.

Do not include the ReferenceType.

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

This HTML element should surround anything that needs to be scrolled if it’s too wide, like prototypes and text diagrams.

my %blockTags

An existence hash of the all-lowercase JavaDoc block tags, not including the @.

sub Body

Returns the topic’s body, formatted in NDMarkup.

The body of the topic, formatted in NDMarkup.

my $bold

Whether list topics should be broken into individual topics in the output.

sub BreakLists

Breaks list topics into individual topics.

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

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.

This file tests Natural Docs’ generated output.

The specific browser versions tested are below.

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.

A package that takes parsed source file and builds the output for it.

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

A base class for all Builder output formats.

A package that generates output in HTML with frames.

A package that generates output in HTML.

A base package for all the shared functionality in NaturalDocs::Builder::HTML and NaturalDocs::Builder::FramedHTML.

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.

my @buildTargets

An array of NaturalDocs::Settings::BuildTargets.

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.