Index - Natural Docs

Internet Explorer

IE4

Internet Explorer 4.x

IE5

Internet Explorer 5.x.

IE6

Internet Explorer 6.x.

IEntry

An entry in the index.

IFile

The file the entry is defined in.

IHeading

A heading for a section of entries.

Implementation

NaturalDocs:: Builder:: Base

NaturalDocs:: ClassHierarchy:: File

NaturalDocs:: Languages:: Advanced

NaturalDocs:: Languages:: Advanced:: Scope

NaturalDocs:: Languages:: Advanced:: ScopeChange

NaturalDocs:: Languages:: Base

NaturalDocs:: Languages:: Simple

NaturalDocs:: Menu:: Entry

NaturalDocs:: Parser:: ParsedTopic

NaturalDocs:: Project:: File

NaturalDocs:: Settings:: BuildTarget

NaturalDocs:: SymbolTable:: File

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: Reference

NaturalDocs:: SymbolTable:: ReferenceTarget

NaturalDocs:: SymbolTable:: Symbol

NaturalDocs:: SymbolTable:: SymbolDefinition

NaturalDocs:: Version

Builder packages are implemented as blessed arrayrefs, not hashrefs.

Since there’s only one member in the class, and it’s a hashref, the class is simply the hashref itself blessed as a class.

The object is implemented as a blessed arrayref.

The class is implemented as a blessed arrayref.

Implemented Interface Functions

NaturalDocs:: Builder:: FramedHTML

NaturalDocs:: Builder:: HTML

NaturalDocs:: Builder:: HTMLBase

The behavior of these functions is shared between HTML output formats.

import, NaturalDocs::DefineMembers

sub import #	(	member,
		member,
		member ...	)

INavigationBar

The navigation bar.

Index

Global

NaturalDocs:: SymbolTable

Surrounds the entire index.

sub Index #(type)

Returns a symbol index.

Index Structure

Everything is enclosed in a IndexSection or an FramedIndexPage.

Index Styles

indexable, NaturalDocs::Topics

my %indexable

An existence hash of the Topic Types that should be indexed.

indexAnchors, NaturalDocs::Builder::HTMLBase

my @indexAnchors

An array of the HTML anchors of all the index sections.

IndexChanged, NaturalDocs::SymbolTable

sub IndexChanged #(type)

Returns whether the specified index has changed.

indexChanges, NaturalDocs::SymbolTable

my %indexChanges

An existence hash of all the indexes that have changed.

indexes

NaturalDocs:: Menu

NaturalDocs:: SymbolTable

my %indexes

An existence hash of all the defined index types appearing in the menu.

my %indexes

A hash of generated symbol indexes.

Indexes, NaturalDocs::Menu

sub Indexes

Returns an existence hashref of all the indexes appearing in the menu.

IndexFileOf, NaturalDocs::Builder::HTMLBase

Returns the output file name of the index file.

indexHeadings, NaturalDocs::Builder::HTMLBase

my @indexHeadings

An array of the headings of all the index sections.

IndexSection

The index section in a non-framed page.

Information Functions

NaturalDocs:: ClassHierarchy

NaturalDocs:: ClassHierarchy:: Class

NaturalDocs:: ClassHierarchy:: File

NaturalDocs:: Languages:: Base

NaturalDocs:: Languages:: Perl

NaturalDocs:: Languages:: Simple

NaturalDocs:: Menu

NaturalDocs:: Menu:: Entry

NaturalDocs:: Project

NaturalDocs:: Settings

NaturalDocs:: SymbolTable

NaturalDocs:: SymbolTable:: File

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: Reference

NaturalDocs:: SymbolTable:: Symbol

NaturalDocs:: SymbolTable:: SymbolDefinition

These functions should not be called until the symbol table is fully resolved.

INIT

Global

NaturalDocs:: Builder:: Base

NaturalDocs:: Builder:: FramedHTML

NaturalDocs:: Builder:: HTML

NaturalDocs:: Extensions:: Base

sub INIT

Define this function to call NaturalDocs::Builder->Add() so that NaturalDocs::Builder knows about this package.

sub INIT

Registers the package with NaturalDocs::Builder.

sub INIT

Registers the package with NaturalDocs::Builder.

For any extension package to be recognized, it must define INIT and have it call NaturalDocs::Extensions->Add() for itself.

inputDirectories, NaturalDocs::Settings

my @inputDirectories

An array of input directories.

InputDirectories, NaturalDocs::Settings

sub InputDirectories

Returns an arrayref of input directories.

InputDirectoryNameOf, NaturalDocs::Settings

sub InputDirectoryNameOf #(directory)

Returns the generated name of the passed input directory.

inputDirectoryNames, NaturalDocs::Settings

my @inputDirectoryNames

An array of the input directory names.

Integer Format, NaturalDocs::Version

Version integers are 16-bit unsigned values.

Interface Functions

NaturalDocs:: Extensions:: Base

NaturalDocs:: Languages

NaturalDocs:: Languages:: Perl

NaturalDocs:: Parser

NaturalDocs:: Parser:: Native

These functions are not for general use.

Interpretations, NaturalDocs::SymbolTable::Reference

sub Interpretations

Returns an array of all the symbol strings that this reference can be interpreted as.

INTERPRETATIONS, NaturalDocs::SymbolTable::Reference

A hashref of the possible interpretations of this reference.

InterpretationsAndScores, NaturalDocs::SymbolTable::Reference

sub InterpretationsAndScores

Returns a hash of all the symbol strings that this reference can be interpreted as and their scores.

InterpretReference, NaturalDocs::SymbolTable

sub InterpretReference #(referenceString)

Interprets the passed reference, matching it to the defined symbol with the highest score.

IPageTitle

The page title.

IParent

The entry parent class.

IsAtSequence, NaturalDocs::Languages::Advanced

sub IsAtSequence #	(	index,
		token, token,
		token ...	)

Returns whether the position is at a sequence of tokens.

IsBackslashed, NaturalDocs::Languages::Advanced

sub IsBackslashed #(index)

Returns whether the position is after a backslash.

IsDefined

NaturalDocs:: ClassHierarchy:: Class

NaturalDocs:: SymbolTable:: Reference

NaturalDocs:: SymbolTable:: Symbol

sub IsDefined

Returns whether the class is defined in any files.

sub IsDefined

Returns whether the reference has any definitions or not.

sub IsDefined

Returns whether the symbol is defined anywhere or not.

IsDefinedIn

NaturalDocs:: ClassHierarchy:: Class

NaturalDocs:: SymbolTable:: Reference

NaturalDocs:: SymbolTable:: Symbol

sub IsDefinedIn #(file)

Returns whether the class is defined in the passed file.

sub IsDefinedIn #(file)

Returns whether the reference is defined in the passed file.

sub IsDefinedIn #(file)

Returns whether the symbol is defined in the passed file.

ISection

A section of entries.

IsFirstLineToken, NaturalDocs::Languages::Advanced

sub IsFirstLineToken #(index)

Returns whether the position is at the first token of a line, not including whitespace.

IsIndexable, NaturalDocs::Topics

sub IsIndexable #(topic)

Returns whether the topic should be indexed.

IsLastLineToken, NaturalDocs::Languages::Advanced

sub IsLastLineToken #(index)

Returns whether the position is at the last token of a line, not including whitespace.

IsList, NaturalDocs::Topics

sub IsList #(topic)

Returns whether the topic is a list topic.

IsListOf, NaturalDocs::Topics

sub IsListOf #(topic)

Returns what type the list topic is a list of.

isQuiet, NaturalDocs::Settings

my $isQuiet

Whether the script should be run in quiet mode or not.

IsQuiet, NaturalDocs::Settings

sub IsQuiet

Returns whether the script should be run in quiet mode or not.

IsStringed, NaturalDocs::Languages::Perl

sub IsStringed #(index)

Returns whether the position is after a string (dollar sign) character.

IsSubPathOf, NaturalDocs::File

sub IsSubPathOf #	(	base,
		path	)

Returns whether the path is a descendant of another path.

IsSupported, NaturalDocs::Languages

sub IsSupported #(file)

Returns whether the language of the passed file is supported.

ISubIndex

Surrounds all IEntry’s in a sub-index.

ISymbol

The entry symbol.