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
 CAN_GROUP_WITH
 CanGroupWith, NaturalDocs::Topics::Type
 CanonizePath, NaturalDocs::File
 CatchDeath, NaturalDocs::Error
 CBody
 CDescriptionList
 CDLDescription
 CDLEntry
 CFCharNames, NaturalDocs::ConfigFile
 CFChars
 Change Detection
 Change Management
 ChangeDefinition
 charset, NaturalDocs::Settings
 CharSet, NaturalDocs::Settings
 CHChild
 CHChildNote
 CHCurrent
 CHeading
 CheckCompatibility, NaturalDocs::File
 CheckFileFormat, NaturalDocs::Version
 CheckForTrashedMenu, NaturalDocs::Menu
 checkingForDirectives, NaturalDocs::Languages::Pascal
 CHEntry
 Children, NaturalDocs::ClassHierarchy::Class
 CHILDREN
 ChildrenOf, NaturalDocs::ClassHierarchy
 CHIndent
 CHParent
 CHType
 CImageCaption
 CImageLink
 Class Hierarchy Structure
 Class Hierarchy Styles
 CLASS_HIERARCHY
 CLASS_HIERARCHY_FILEHANDLE, NaturalDocs::ClassHierarchy
 classes, NaturalDocs::ClassHierarchy
 Classes, NaturalDocs::ClassHierarchy::File
 ClassHierarchy
NaturalDocs::ClassHierarchy
 ClassHierarchy.nd
NaturalDocs::ClassHierarchy::Class
NaturalDocs::ClassHierarchy::File
 classKeywords, NaturalDocs::Languages::CSharp
 classModifiers
 ClassReferenceOf, NaturalDocs::ClassHierarchy
 CleanComment, NaturalDocs::Parser
 ClearAutoTopics, NaturalDocs::Languages::Advanced
 ClearScopeStack, NaturalDocs::Languages::Advanced
 ClearTokens, NaturalDocs::Languages::Advanced
 Close
 CloseResultsWindow, SearchPanel
 CLOSING_SYMBOL
 ClosingBrowserStyles, NaturalDocs::Builder::HTMLBase
 ClosingScopeSymbol, NaturalDocs::Languages::Advanced
 ClosingSymbol, NaturalDocs::Languages::Advanced::Scope
 ClosingTag, NaturalDocs::Parser::Native
 Code Conventions
 COMBINED_TYPE
 CombinedType, NaturalDocs::SymbolTable::IndexElement
 CommandLineOption
 Comment Processing
 Comment Type Determination
 Compare, NaturalDocs::SourceDB::ItemDefinition
 CompareEntries, NaturalDocs::Menu
 completed, NaturalDocs::StatusMessage
 CompletedItem, NaturalDocs::StatusMessage
 Conclusion
 Config and Data File Functions, NaturalDocs::Project
 CONFIG_FILEHANDLE, NaturalDocs::ConfigFile
 ConfigDirectory, NaturalDocs::Settings
NaturalDocs::ConfigFile
 ConfigFileInfo.nd
 Configuration File Variables, NaturalDocs::Project
 Constant Functions, NaturalDocs::Settings
 Constants
NaturalDocs::Constants
 Constants and Types, NaturalDocs::Languages::ActionScript
 Content, NaturalDocs::Menu
 Content Structure
 Content Styles
 ContentPage
 ConvertAmpChars
 ConvertLink, NaturalDocs::Parser::JavaDoc
 ConvertToURL, NaturalDocs::File
 Copy, NaturalDocs::File
 CopyIgnoredPrefixesOf, NaturalDocs::Languages::Base
 CreateDirectorySubGroups, NaturalDocs::Menu
 CreatePath, NaturalDocs::File
 CreateString, NaturalDocs::Languages::Advanced
 CSS Structure
 CSSDirectory, NaturalDocs::Builder::HTMLBase
 CTitle
 CToolTip
 CTopic
 CType
 CURRENT_INTERPRETATION
 currentAction, NaturalDocs::Error
 currentFile, NaturalDocs::BinaryFile
 CurrentInterpretation, NaturalDocs::SymbolTable::Reference
 CurrentPackage, NaturalDocs::Languages::Advanced
 CurrentScope, NaturalDocs::Languages::Advanced
 CurrentScore, NaturalDocs::SymbolTable::Reference
 CurrentUsing, NaturalDocs::Languages::Advanced
The existence hashref of TopicTypes the type can be grouped with.
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.
The body of a topic.
A description list, which is the type of list you’re reading right now.
A description list description, which is the right side.
A description list entry, which is the left side.
sub CFCharNames
Returns a plain-english list of CFChars which can be embedded in a sentence.
The characters that can appear in configuration file keywords and user-defined element names: letters, numbers, spaces, dashes, slashes, apostrophes, and periods.
Change management is handled a couple of ways.
When a symbol’s global definition changes, either because it switches to another file or because the details of the current file’s definition changed (prototype, summary, etc.)
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.
my $charset
The character encoding of the source files, and thus the output.
sub CharSet
Returns the character set, or undef if none.
The style for a child class.
The style for when a child is added that just shows how many other children were omitted.
The style for the current class, which is the one the hierarchy is generated for.
Surrounds a heading.
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.
my $checkingForDirectives
Set after the first function semicolon, which means we’re in directives mode.
A generic class entry.
sub Children
Returns an array of the child SymbolStrings, or an empty array if none.
An existence hashref of the SymbolStrings of all the children this class has.
sub ChildrenOf #(class)
Returns a SymbolString array of the passed class’ children, or an empty array if none.
A style used to indent a level.
The style for a parent class.
CHParent, CHCurrent, CHChild, or CHChildNote.
Surrounds an image caption.
Surrounds a link to an image.
Everything is contained in a single ClassHierarchy.
Whether the topic is part of the class hierarchy.
The file handle used with ClassHierarchy.nd.
my %classes
A hash of all the classes.
sub Classes
Returns an array of the class SymbolStrings that are defined by this file, or an empty array if none.
The topmost style containing everything.
Returns whether the topic is part of the class hierarchy.
A package that handles all the gory details of managing the class hierarchy.
Stores the class hierarchy on disk.
An object that stores information about a class in the hierarchy.
An object that stores information about what hierarchy information is present in a file.
my %classKeywords
An existence hash of all the acceptable class keywords.
my %classModifiers
An existence hash of all the acceptable class modifiers.
my %classModifiers
An existence hash of all the acceptable class modifiers.
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.
The closing symbol character of the scope.
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.
The combined TopicType of the element.
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.
NaturalDocs::Parser->OnComment() receives the comment sans comment symbols, since that’s language specific.
OnComment() sends the comment to NaturalDocs::Parser::Native->IsMine() to test if it’s definitely Natural Docs content, such as by starting with a recognized header line.
sub Compare #(other)
Returns whether the definitions are equal.
sub CompareEntries #(a,
b)
A comparison function for use in sorting.
my $completed
The number of items completed.
sub CompletedItem
Should be called every time an item is completed.
Thus ends all processing by NaturalDocs::Parser->Parse().
The file handle used for the configuration file.
sub ConfigDirectory
Returns the main configuration directory.
A package to manage Natural Docs’ configuration files.
An index of the state of the config files as of the last parse.
Constants that are used throughout the script.
sub Content
Returns the parsed menu as an arrayref of NaturalDocs::Menu::Entry objects.
All the topics of a given file is contained in a #Content.
An unframed content page.
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.
It’s important to understand the internal HTML file structure and styles in order to design your own CSS style for Natural Docs.
sub CSSDirectory
Returns the directory of the CSS files.
The title of a topic.
Surrounds the entire tool tip.
An individual topic.
A placeholder for all type-specific styles.
The interpretation currently used as the reference target.
my $currentAction
What Natural Docs was doing when it crashed.
my $currentFile
The FileName for the current configuration file being parsed.
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.
Close