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

C
	CanGroupWith, NaturalDocs::Topics::Type
	CanonizePath, NaturalDocs::File
	CatchDeath, NaturalDocs::Error
	CFCharNames, NaturalDocs::ConfigFile
	ChangeDefinition NaturalDocs::SourceDB NaturalDocs::SourceDB::Item NaturalDocs::SymbolTable::Symbol
	CharSet, NaturalDocs::Settings
	CheckCompatibility, NaturalDocs::File
	CheckFileFormat, NaturalDocs::Version
	CheckForTrashedMenu, NaturalDocs::Menu
	Children, NaturalDocs::ClassHierarchy::Class
	ChildrenOf, NaturalDocs::ClassHierarchy
	Classes, NaturalDocs::ClassHierarchy::File
	ClassHierarchy, NaturalDocs::Topics::Type
	ClassReferenceOf, NaturalDocs::ClassHierarchy
	CleanComment, NaturalDocs::Parser
	ClearAutoTopics, NaturalDocs::Languages::Advanced
	ClearScopeStack, NaturalDocs::Languages::Advanced
	ClearTokens, NaturalDocs::Languages::Advanced
	Close NaturalDocs::BinaryFile NaturalDocs::ConfigFile
	CloseResultsWindow, SearchPanel
	ClosingBrowserStyles, NaturalDocs::Builder::HTMLBase
	ClosingScopeSymbol, NaturalDocs::Languages::Advanced
	ClosingSymbol, NaturalDocs::Languages::Advanced::Scope
	ClosingTag, NaturalDocs::Parser::Native
	CombinedType, NaturalDocs::SymbolTable::IndexElement
	CommandLineOption NaturalDocs::Builder::Base NaturalDocs::Builder::FramedHTML NaturalDocs::Builder::HTML
	Compare, NaturalDocs::SourceDB::ItemDefinition
	CompareEntries, NaturalDocs::Menu
	CompletedItem, NaturalDocs::StatusMessage
	ConfigDirectory, NaturalDocs::Settings
	Content, NaturalDocs::Menu
	ConvertAmpChars NaturalDocs::Builder::HTMLBase NaturalDocs::Menu NaturalDocs::NDMarkup NaturalDocs::Parser::JavaDoc
	ConvertLink, NaturalDocs::Parser::JavaDoc
	ConvertToURL, NaturalDocs::File
	Copy, NaturalDocs::File
	CopyIgnoredPrefixesOf, NaturalDocs::Languages::Base
	CreateDirectorySubGroups, NaturalDocs::Menu
	CreatePath, NaturalDocs::File
	CreateString, NaturalDocs::Languages::Advanced
	CSSDirectory, NaturalDocs::Builder::HTMLBase
	CurrentInterpretation, NaturalDocs::SymbolTable::Reference
	CurrentPackage, NaturalDocs::Languages::Advanced
	CurrentScope, NaturalDocs::Languages::Advanced
	CurrentScore, NaturalDocs::SymbolTable::Reference
	CurrentUsing, NaturalDocs::Languages::Advanced

sub CanGroupWith #( TopicType type ) -> bool

Returns whether the type can be grouped with the passed TopicType.

sub CanonizePath #( path )

Takes a path and returns a logically simplified version of it.

sub CatchDeath #( message )

Catches Perl die calls.

sub CFCharNames

Returns a plain-english list of CFChars which can be embedded in a sentence.

sub ChangeDefinition #( ExtensionID extension,
string itemString,
FileName file,
NaturalDocs::SourceDB:: ItemDefinition definition )

Changes the definition of an item.

sub ChangeDefinition #( FileName file,
NaturalDocs::SourceDB:: ItemDefinition definition )

Changes the definition for the passed FileName.

sub ChangeDefinition #( file,
type,
prototype,
summary )

Changes the information about an existing definition.

sub CharSet

Returns the character set, or undef if none.

sub CheckCompatibility

Checks if the standard packages required by this one are up to snuff and dies if they aren’t.

sub CheckFileFormat #( VersionInt fileVersion,
optional VersionInt minimumVersion ) => bool

Checks if a file’s format is compatible with the current release.

sub CheckForTrashedMenu #( numberOriginallyInMenu,
numberRemoved )

Checks the menu to see if a significant number of file entries didn’t resolve to actual files, and if so, saves a backup of the menu and issues a warning.

sub Children

Returns an array of the child SymbolStrings, or an empty array if none.

sub ChildrenOf #( class )

Returns a SymbolString array of the passed class’ children, or an empty array if none.

sub Classes

Returns an array of the class SymbolStrings that are defined by this file, or an empty array if none.

Returns whether the topic is part of the class hierarchy.

sub ClassReferenceOf #( class,
languageName )

Returns the REFERENCE_CH_CLASS ReferenceString of the passed class SymbolString.

sub CleanComment #( commentLines )

Removes any extraneous formatting and whitespace from the comment.

sub ClearAutoTopics

Resets the automatic topic list.

sub ClearScopeStack

Clears the scope stack for a new file.

sub ClearTokens

Resets the token list.

sub Close

Closes the current configuration file.

sub Close

Closes the current configuration file.

this.CloseResultsWindow = function()

Closes the results window.

sub ClosingBrowserStyles

Returns the JavaScript that will close browser styles if necessary.

sub ClosingScopeSymbol

Returns the symbol that ends the current scope level, or undef if we are at the top level.

sub ClosingSymbol

Returns the closing symbol character of the scope.

sub ClosingTag #( textBlocks,
index,
hasWhitespace )

Returns whether a tag is closed or not, where it’s closed if it is, and optionally whether there is any whitespace between the tags.

Returns the combined TopicType of the element.

sub CommandLineOption

Define this function to return the text that should be put in the command line after -o to use this package.

sub CommandLineOption

Returns the option to follow -o to use this package.

sub CommandLineOption

Returns the option to follow -o to use this package.

sub Compare #( other )

Returns whether the definitions are equal.

sub CompareEntries #( a,
b )

A comparison function for use in sorting.

sub CompletedItem

Should be called every time an item is completed.

sub ConfigDirectory

Returns the main configuration directory.

sub Content

Returns the parsed menu as an arrayref of NaturalDocs::Menu::Entry objects.

sub ConvertAmpChars #( text )

Converts certain characters to their HTML amp char equivalents.

sub ConvertAmpChars #( string text,
int flags ) => string

Replaces certain characters in the string with their entities and returns it.

sub ConvertAmpChars #( text )

Substitutes certain characters with their NDMarkup amp chars.

sub ConvertAmpChars #( text )

sub ConvertLink #( text )

sub ConvertToURL #( path )

Takes a relative path and converts it from the native format to a relative URL.

sub Copy #( source,
destination ) => bool

Copies a file from one path to another.

sub CopyIgnoredPrefixesOf #( language )

Copies all the ignored prefix settings of the passed NaturalDocs::Languages::Base object.

sub CreateDirectorySubGroups

Where possible, creates sub-groups based on directories for any long groups that have MENU_GROUP_UPDATESTRUCTURE set.

sub CreatePath #( path )

Creates a directory tree corresponding to the passed path, regardless of how many directories do or do not already exist.

sub CreateString #( startIndex,
endIndex )

Converts the specified tokens into a string and returns it.

sub CSSDirectory

Returns the directory of the CSS files.

sub CurrentInterpretation

Returns the SymbolString of the current interpretation, or undef if none.

sub CurrentPackage

Returns the current calculated package or class, or undef if none.

sub CurrentScope

Returns the current calculated scope, or undef if global.

sub CurrentScore

Returns the score of the current interpretation, or undef if none.

sub CurrentUsing

Returns the current calculated arrayref of SymbolStrings from Using statements, or undef if none.