Function 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
	IEWebMark, NaturalDocs::Builder::HTMLBase
	IgnoredPrefix, NaturalDocs::SymbolTable::IndexElement
	IgnoredPrefixesFor, NaturalDocs::Languages::Base
	IgnoredPrefixLength, NaturalDocs::Languages::Base
	ImageDirectories, NaturalDocs::Settings
	ImageDirectoryNameOf, NaturalDocs::Settings
	ImageFileCapitalization, NaturalDocs::Project
	ImageFileDimensions, NaturalDocs::Project
	ImageFileExists, NaturalDocs::Project
	ImageFilesToPurge, NaturalDocs::Project
	ImageFilesToUpdate, NaturalDocs::Project
	import, NaturalDocs::DefineMembers
	InactivateAfterTimeout, SearchPanel
	Index NaturalDocs::SymbolTable NaturalDocs::Topics::Type
	IndexChanged, NaturalDocs::SymbolTable
	IndexDirectory, NaturalDocs::Builder::HTMLBase
	Indexes, NaturalDocs::Menu
	IndexFileOf, NaturalDocs::Builder::HTMLBase
	IndexSectionsWithContent, NaturalDocs::SymbolTable
	IndexTitleOf, NaturalDocs::Builder::HTMLBase
	IndiscriminateSkipUntilAfterSequence, NaturalDocs::Languages::ActionScript
	InformationOf NaturalDocs::ImageReferenceTable::String NaturalDocs::ReferenceString
	INIT Global NaturalDocs::Builder::Base NaturalDocs::Builder::FramedHTML NaturalDocs::Builder::HTML
	InputDirectories, NaturalDocs::Settings
	InputDirectoryNameOf, NaturalDocs::Settings
	Interpretations, NaturalDocs::SymbolTable::Reference
	InterpretationsAndScores, NaturalDocs::SymbolTable::Reference
	InterpretReference, NaturalDocs::SymbolTable
	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
	IsFirstLineToken, NaturalDocs::Languages::Advanced
	IsLastLineToken, NaturalDocs::Languages::Advanced
	IsList, NaturalDocs::Parser::ParsedTopic
	IsMine NaturalDocs::Parser::JavaDoc NaturalDocs::Parser::Native
	IsQuiet, NaturalDocs::Settings
	IsStringed, NaturalDocs::Languages::Perl
	IsSubPathOf, NaturalDocs::File
	IsValidType, NaturalDocs::Topics
J
	JavaScriptDirectory NaturalDocs::Builder::HTMLBase NaturalDocs::Settings
	Join, NaturalDocs::SymbolString
	JoinDirectories, NaturalDocs::File
	JoinPath, NaturalDocs::File
	JoinPaths, NaturalDocs::File
K
	KeywordInfo, NaturalDocs::Topics

sub IdentifiersOf #( SymbolString symbol )

Returns the SymbolString as an array of identifiers.

sub IEWebMark

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

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.

sub ImageDirectories

Returns an arrayref of image directories.

sub ImageDirectoryNameOf #( directory )

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

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.

sub ImageFilesToPurge

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

sub ImageFilesToUpdate

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

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

this.InactivateAfterTimeout = function()

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

sub Index #( type )

Returns a symbol index.

Whether the topic is indexed.

sub IndexChanged #( TopicType type )

Returns whether the specified index has changed.

sub IndexDirectory

Returns the directory of the index files.

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.

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.

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.

sub InputDirectories

Returns an arrayref of input directories.

sub InputDirectoryNameOf #( directory )

Returns the generated name of the passed input directory.

sub Interpretations

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

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.

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.

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.

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.

sub IsValidType #( type )

Returns whether the passed TopicType is defined.

sub JavaScriptDirectory

Returns the directory of the JavaScript files.

sub JavaScriptDirectory

Returns the main JavaScript directory.

sub Join #( string/SymbolString identifier/symbol,
string/SymolString identifier/symbol,
... )

Takes a list of identifiers and/or SymbolStrings and returns it as a new SymbolString.

sub JoinDirectories #( directory,
directory,
... )

Creates a directory string from an array of directory names.

sub JoinPath #( volume,
dirString,
$file )

Creates a path from its elements.

sub JoinPaths #( basePath,
extraPath,
noFileInExtra )

Joins two paths.

sub KeywordInfo #( keyword )

Returns information about a topic keyword.