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

I
	IdentifiersOf, NaturalDocs::SymbolString
	IE
	IE6
	IE7
	IEntry
	IEWebMark, NaturalDocs::Builder::HTMLBase
	IFile
	IGNORED_PREFIX
	IgnoredPrefix, NaturalDocs::SymbolTable::IndexElement
	IgnoredPrefixesFor, NaturalDocs::Languages::Base
	IgnoredPrefixLength, NaturalDocs::Languages::Base
	IHeading
	Image File Functions, NaturalDocs::Project
	Image File Variables, NaturalDocs::Project
	Image Package Variables, NaturalDocs::Builder::HTMLBase
	imageAnchorNumber, NaturalDocs::Builder::HTMLBase
	imageContent, NaturalDocs::Builder::HTMLBase
	imageDirectories, NaturalDocs::Settings
	ImageDirectories, NaturalDocs::Settings
	ImageDirectoryNameOf, NaturalDocs::Settings
	imageDirectoryNames, NaturalDocs::Settings
	ImageFileCapitalization, NaturalDocs::Project
	ImageFileDimensions, NaturalDocs::Project
	ImageFileExists, NaturalDocs::Project
	imageFileExtensions, NaturalDocs::Project
	ImageFileInfo.nd
	imageFiles, NaturalDocs::Project
	imageFilesToPurge, NaturalDocs::Project
	ImageFilesToPurge, NaturalDocs::Project
	imageFilesToUpdate, NaturalDocs::Project
	ImageFilesToUpdate, NaturalDocs::Project
	ImageReferenceString
NaturalDocs::	ImageReferenceTable
	ImageReferenceTable.nd
NaturalDocs::	ImageReferenceTable::Reference
NaturalDocs::	ImageReferenceTable::String
	Images
	Implementation Global Modules\NaturalDocs\Languages\Advanced\Scope.pm Modules\NaturalDocs\Languages\Advanced\ScopeChange.pm NaturalDocs::Builder::Base NaturalDocs::ClassHierarchy::File NaturalDocs::ImageReferenceTable NaturalDocs::Languages::Advanced NaturalDocs::Menu::Entry NaturalDocs::Parser::ParsedTopic NaturalDocs::Project::ImageFile NaturalDocs::Project::SourceFile NaturalDocs::SymbolTable::File NaturalDocs::SymbolTable::IndexElement NaturalDocs::SymbolTable::Reference NaturalDocs::SymbolTable::ReferenceTarget NaturalDocs::SymbolTable::Symbol NaturalDocs::SymbolTable::SymbolDefinition NaturalDocs::Version
	Implemented Interface Functions NaturalDocs::Builder::FramedHTML NaturalDocs::Builder::HTML NaturalDocs::Builder::HTMLBase
	import, NaturalDocs::DefineMembers
	impossibleTypeWords, NaturalDocs::Languages::CSharp
	InactivateAfterTimeout, SearchPanel
	INavigationBar
$	index, NaturalDocs::Parser::Native
	Index NaturalDocs::SymbolTable NaturalDocs::Topics::Type
	INDEX
	Index Functions, NaturalDocs::Builder::HTMLBase
	Index Structure
	Index Styles
	indexable, NaturalDocs::Topics
	indexAnchors, NaturalDocs::Builder::HTMLBase
	IndexChanged, NaturalDocs::SymbolTable
	indexChanges, NaturalDocs::SymbolTable
	IndexDirectory, NaturalDocs::Builder::HTMLBase
	indexes NaturalDocs::Menu NaturalDocs::SymbolTable
	Indexes, NaturalDocs::Menu
	IndexFileOf, NaturalDocs::Builder::HTMLBase
	indexHeadings, NaturalDocs::Builder::HTMLBase
	IndexInfo.nd
	IndexPage
	indexSectionsWithContent, NaturalDocs::SymbolTable
	IndexSectionsWithContent, NaturalDocs::SymbolTable
	IndexTitleOf, NaturalDocs::Builder::HTMLBase
	IndiscriminateSkipUntilAfterSequence, NaturalDocs::Languages::ActionScript
	Information NaturalDocs::ImageReferenceTable NaturalDocs::Settings
	Information Functions NaturalDocs::ClassHierarchy NaturalDocs::ClassHierarchy::Class NaturalDocs::ClassHierarchy::File NaturalDocs::Menu NaturalDocs::Settings NaturalDocs::SymbolTable NaturalDocs::SymbolTable::File NaturalDocs::SymbolTable::Reference NaturalDocs::SymbolTable::Symbol
	InformationOf NaturalDocs::ImageReferenceTable::String NaturalDocs::ReferenceString
	INIT Global NaturalDocs::Builder::Base NaturalDocs::Builder::FramedHTML NaturalDocs::Builder::HTML
	inlineTags, NaturalDocs::Parser::JavaDoc
	inputDirectories, NaturalDocs::Settings
	InputDirectories, NaturalDocs::Settings
	InputDirectoryNameOf, NaturalDocs::Settings
	inputDirectoryNames, NaturalDocs::Settings
	insensitiveImageFiles, NaturalDocs::Project
	Integer Format, NaturalDocs::Version
	Interface Functions NaturalDocs::ClassHierarchy NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl NaturalDocs::Parser NaturalDocs::Parser::Native NaturalDocs::SourceDB::Extension
	Internal Overview, NaturalDocs::Settings
	Interpretations, NaturalDocs::SymbolTable::Reference
	INTERPRETATIONS
	InterpretationsAndScores, NaturalDocs::SymbolTable::Reference
	InterpretReference, NaturalDocs::SymbolTable
	IPageTitle
	IParent
	IS_LIST
	IsAtSequence, NaturalDocs::Languages::Advanced
	IsBackslashed, NaturalDocs::Languages::Advanced
	IsCaseSensitive, NaturalDocs::File
	IsClassHierarchyReference, NaturalDocs::Constants
	IsDefined NaturalDocs::ClassHierarchy::Class NaturalDocs::SymbolTable::Reference NaturalDocs::SymbolTable::Symbol
	IsDefinedIn NaturalDocs::ClassHierarchy::Class NaturalDocs::SymbolTable::Reference NaturalDocs::SymbolTable::Symbol
	IsDevelopmentRelease, NaturalDocs::Version
	isEscaped, NaturalDocs::Languages::ActionScript
	IsFirstLineToken, NaturalDocs::Languages::Advanced
	IsLastLineToken, NaturalDocs::Languages::Advanced
	IsList, NaturalDocs::Parser::ParsedTopic
	IsMine NaturalDocs::Parser::JavaDoc NaturalDocs::Parser::Native
	isQuiet, NaturalDocs::Settings
	IsQuiet, NaturalDocs::Settings
	IsStringed, NaturalDocs::Languages::Perl
	IsSubPathOf, NaturalDocs::File
	ISubIndex
	IsValidType, NaturalDocs::Topics
	ISymbol
	ISymbolPrefix
	Item Functions, NaturalDocs::SourceDB
	items, NaturalDocs::SourceDB
	ITEMS, NaturalDocs::SourceDB::File

sub IdentifiersOf #( SymbolString symbol )

Returns the SymbolString as an array of identifiers.

Internet Explorer

Internet Explorer 6.x.

Internet Explorer 7.x.

An entry in the index.

sub IEWebMark

Returns the HTML comment necessary to get around the security warnings in IE starting with Windows XP Service Pack 2.

The file the entry is defined in.

The part of the symbol that was stripped off to make the sortable symbol.

Returns the part of the symbol that was stripped off to make the SortableSymbol(), or undef if none.

sub IgnoredPrefixesFor #( type )

Returns an arrayref of ignored prefixes for the passed TopicType, or undef if none.

sub IgnoredPrefixLength #( name,
type )

Returns the length of the prefix that should be ignored in the index, or zero if none.

An index heading, such as the letter for the group.

These variables are for the image generation functions only.

my $imageAnchorNumber

Incremented for each image link in the file that requires an anchor.

my $imageContent

The actual embedded image HTML for all image links.

my @imageDirectories

An array of image directories.

sub ImageDirectories

Returns an arrayref of image directories.

sub ImageDirectoryNameOf #( directory )

Returns the generated name of the passed image or input directory.

my @imageDirectoryNames

An array of the image directory names.

sub ImageFileCapitalization #( FileName file ) => FileName

Returns the properly capitalized version of the passed image FileName.

sub ImageFileDimensions #( FileName file ) => (int, int)

Returns the dimensions of the passed image file as the array ( width, height ).

sub ImageFileExists #( FileName file ) => bool

Returns whether the passed image file exists.

my %imageFileExtensions

An existence hash of all the file extensions for images.

An index of the state of the image files as of the last parse.

my %imageFiles

A hash of all the image files in the project.

my %imageFilesToPurge

An existence hash of all the image FileNames that need to be purged, either because the files no longer exist or because they are no longer used.

sub ImageFilesToPurge

Returns an existence hashref of image FileNames that need to be updated.

my %imageFilesToUpdate

An existence hash of all the image FileNames that need to be updated, either because they changed or they’re new to the project.

sub ImageFilesToUpdate

Returns an existence hashref of image FileNames that need to be updated.

A string representing a unique image reference.

A NaturalDocs::SourceDB-based package that manages all the image references appearing in source files.

The data file which stores all the image references from the last run of Natural Docs.

A class for references being tracked in NaturalDocs::SourceDB.

A package for creating and managing ImageReferenceStrings.

The object is implemented as a blessed arrayref.

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.

Managing image references is simpler than managing the references in NaturalDocs::SymbolTable.

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

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

my %impossibleTypeWords

An existence hash of all the reserved words that cannot be in a type.

this.InactivateAfterTimeout = function()

Called by inactivateTimeout, which is set by Activate().

The navigation bar.

my $index

sub Index #( type )

Returns a symbol index.

Whether the topic is indexed.

Everything is enclosed in an #Index.

my %indexable

An existence hash of all the indexable TopicTypes.

my @indexAnchors

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

sub IndexChanged #( TopicType type )

Returns whether the specified index has changed.

my %indexChanges

A hash of all the indexes that have changed.

sub IndexDirectory

Returns the directory of the index files.

my %indexes

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

my %indexes

A hash of generated symbol indexes.

sub Indexes

Returns an existence hashref of all the index TopicTypes appearing in the menu.

sub IndexFileOf #( type,
page )

Returns the output file name of the index file.

my @indexHeadings

An array of the headings of all the index sections.

The storage file for information about the indexes.

An unframed index page.

my %indexSectionsWithContent

A hash of which sections in an index have content.

sub IndexSectionsWithContent #( TopicType type )

Returns an arrayref of whether each section of the specified index has content.

sub IndexTitleOf #( type )

Returns the page title of the index file.

sub IndiscriminateSkipUntilAfterSequence #( indexRef,
lineNumberRef,
token,
token,
... )

Advances the position indiscriminately until a specific token sequence is reached and passed.

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

sub InformationOf #( ImageReferenceString referenceString )

Returns the information contained in the ImageReferenceString as the array ( path, text ).

sub InformationOf #( ReferenceString referenceString )

Returns the information encoded in a ReferenceString.

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.

my %inlineTags

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

my @inputDirectories

An array of input directories.

sub InputDirectories

Returns an arrayref of input directories.

sub InputDirectoryNameOf #( directory )

Returns the generated name of the passed input directory.

my @inputDirectoryNames

An array of the input directory names.

my %insensitiveImageFiles

A hash that maps all lowercase image FileNames to their proper case as it would appear in imageFiles.

VersionInts are 32-bit values with the bit distribution below.

These functions must be overridden by the derived class.

sub Interpretations

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

A hashref of the possible interpretations of this reference.

sub InterpretationsAndScores

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

sub InterpretReference #( referenceString )

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

The page title.

The entry parent class.

Whether the topic is a list.

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

Returns whether the position is at a sequence of tokens.

sub IsBackslashed #( index )

Returns whether the position is after a backslash.

sub IsCaseSensitive

Returns whether the current platform has case-sensitive paths.

sub IsClassHierarchyReference #( reference )

Returns whether the passed ReferenceType belongs to NaturalDocs::ClassHierarchy.

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.

sub IsDefinedIn #( file )

Returns whether the class is defined in the passed FileName.

sub IsDefinedIn #( file )

Returns whether the reference is defined in the passed FileName.

sub IsDefinedIn #( file )

Returns whether the symbol is defined in the passed FileName.

sub IsDevelopmentRelease #( VersionInt version ) => bool

Returns whether the passed VersionInt is for a development release.

my $isEscaped

Whether the current file being parsed uses escapement.

sub IsFirstLineToken #( index )

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

sub IsLastLineToken #( index )

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

sub IsList

Returns whether the topic is a list.

sub IsMine #( string[] commentLines,
bool isJavaDoc )

Examines the comment and returns whether it is definitely JavaDoc content, i.e.

sub IsMine #( string[] commentLines,
bool isJavaDoc )

Examines the comment and returns whether it is definitely Natural Docs content, i.e.

my $isQuiet

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

sub IsQuiet

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

sub IsStringed #( index )

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

sub IsSubPathOf #( base,
path )

Returns whether the path is a descendant of another path.

The surrounding block if an entry needs to be broken out into a sub-index.

sub IsValidType #( type )

Returns whether the passed TopicType is defined.

The entry symbol.

The stripped prefix of the entry.

my @items

The array of source items.

An arrayref where an ExtensionID is the index and the members are existence hashrefs of the item strigs defined in this file.