C | |
CACHED_LINES | |
CAN_GROUP_WITH | |
CanGroupWith, NaturalDocs:: | |
CanonizePath, NaturalDocs:: | |
CatchDeath, NaturalDocs:: | |
CBody | |
CDescriptionList | |
CDLDescription | |
CDLEntry | |
CFCharNames, NaturalDocs:: | |
CFChars | |
Change Detection | |
Change Management | |
ChangeDefinition | |
CHChild | |
CHChildNote | |
CHCurrent | |
CHeading | |
CheckCompatibility, NaturalDocs:: | |
CheckFileFormat, NaturalDocs:: | |
CheckForTrashedMenu, NaturalDocs:: | |
checkingForDirectives, NaturalDocs:: | |
CHEntry | |
Children, NaturalDocs:: | |
CHILDREN | |
ChildrenOf, NaturalDocs:: | |
CHIndent | |
Chomp, NaturalDocs:: | |
CHParent | |
CHType | |
CImageCaption | |
CImageLink | |
Class Hierarchy Structure | |
Class Hierarchy Styles | |
CLASS_HIERARCHY | |
CLASS_HIERARCHY_FILEHANDLE, NaturalDocs:: | |
classes, NaturalDocs:: | |
Classes, NaturalDocs:: | |
ClassHierarchy | |
NaturalDocs:: | ClassHierarchy |
ClassHierarchy.nd | |
NaturalDocs:: | ClassHierarchy:: |
NaturalDocs:: | ClassHierarchy:: |
classKeywords, NaturalDocs:: | |
classModifiers | |
ClassReferenceOf, NaturalDocs:: | |
CleanComment, NaturalDocs:: | |
ClearAutoTopics, NaturalDocs:: | |
ClearScopeStack, NaturalDocs:: | |
ClearTokens, NaturalDocs:: | |
Close | |
CloseResultsWindow, SearchPanel | |
CLOSING_SYMBOL | |
ClosingBrowserStyles, NaturalDocs:: | |
ClosingScopeSymbol, NaturalDocs:: | |
ClosingSymbol, NaturalDocs:: | |
ClosingTag, NaturalDocs:: | |
Code Conventions | |
COMBINED_TYPE | |
CombinedType, NaturalDocs:: | |
CommandLineOption | |
Comment Processing | |
Comment Type Determination | |
Compare, NaturalDocs:: | |
CompareEntries, NaturalDocs:: | |
completed, NaturalDocs:: | |
CompletedItem, NaturalDocs:: | |
Conclusion | |
Config and Data File Functions, NaturalDocs:: | |
CONFIG_FILEHANDLE, NaturalDocs:: | |
ConfigDirectory, NaturalDocs:: | |
NaturalDocs:: | ConfigFile |
ConfigFileInfo.nd | |
Configuration File Variables, NaturalDocs:: | |
Constant Functions, NaturalDocs:: | |
Constants | |
NaturalDocs:: | Constants |
Constants and Types, NaturalDocs:: | |
Content, NaturalDocs:: | |
Content Structure | |
Content Styles | |
ContentPage | |
ConvertAmpChars | |
ConvertLink, NaturalDocs:: | |
ConvertToURL, NaturalDocs:: | |
Copy, NaturalDocs:: | |
CopyIgnoredPrefixesOf, NaturalDocs:: | |
CreateDirectorySubGroups, NaturalDocs:: | |
CreatePath, NaturalDocs:: | |
CreateString, NaturalDocs:: | |
CSS Structure | |
CSSDirectory, NaturalDocs:: | |
CTitle | |
CToolTip | |
CTopic | |
CType | |
CURRENT_INTERPRETATION | |
currentAction, NaturalDocs:: | |
currentFile, NaturalDocs:: | |
CurrentInterpretation, NaturalDocs:: | |
CurrentPackage, NaturalDocs:: | |
CurrentScope, NaturalDocs:: | |
CurrentScore, NaturalDocs:: | |
CurrentUsing, NaturalDocs:: |
Returns whether the type can be grouped with the passed TopicType.
sub CanGroupWith #( TopicType type ) -> bool
Takes a path and returns a logically simplified version of it.
sub CanonizePath #( path )
Catches Perl die calls.
sub CatchDeath #( message )
Returns a plain-english list of CFChars which can be embedded in a sentence.
sub CFCharNames
Changes the definition of an item.
sub ChangeDefinition #( ExtensionID extension, string itemString, FileName file, NaturalDocs::SourceDB:: ItemDefinition definition )
Changes the definition for the passed FileName.
sub ChangeDefinition #( FileName file, NaturalDocs::SourceDB:: ItemDefinition definition )
Changes the information about an existing definition.
sub ChangeDefinition #( file, type, prototype, summary )
Checks if the standard packages required by this one are up to snuff and dies if they aren’t.
sub CheckCompatibility
Checks if a file’s format is compatible with the current release.
sub CheckFileFormat #( VersionInt fileVersion, optional VersionInt minimumVersion ) => bool
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 CheckForTrashedMenu #( numberOriginallyInMenu, numberRemoved )
Set after the first function semicolon, which means we’re in directives mode.
my $checkingForDirectives
Returns an array of the child SymbolStrings, or an empty array if none.
sub Children
Returns a SymbolString array of the passed class’ children, or an empty array if none.
sub ChildrenOf #( class )
Removes any line breaks from the end of a value.
sub Chomp #( lineRef )
A hash of all the classes.
my %classes
Returns an array of the class SymbolStrings that are defined by this file, or an empty array if none.
sub Classes
An existence hash of all the acceptable class keywords.
my %classKeywords
An existence hash of all the acceptable class modifiers.
my %classModifiers
An existence hash of all the acceptable class modifiers.
my %classModifiers
Returns the REFERENCE_CH_CLASS ReferenceString of the passed class SymbolString.
sub ClassReferenceOf #( class, languageName )
Removes any extraneous formatting and whitespace from the comment.
sub CleanComment #( commentLines )
Resets the automatic topic list.
sub ClearAutoTopics
Clears the scope stack for a new file.
sub ClearScopeStack
Resets the token list.
sub ClearTokens
Closes the current configuration file.
sub Close
Closes the current configuration file.
sub Close
Closes the results window.
this.CloseResultsWindow = function()
Returns the JavaScript that will close browser styles if necessary.
sub ClosingBrowserStyles
Returns the symbol that ends the current scope level, or undef if we are at the top level.
sub ClosingScopeSymbol
Returns the closing symbol character of the scope.
sub ClosingSymbol
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.
sub ClosingTag #( textBlocks, index, hasWhitespace )
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 CommandLineOption
Returns whether the definitions are equal.
sub Compare #( other )
A comparison function for use in sorting.
sub CompareEntries #( a, b )
The number of items completed.
my $completed
Should be called every time an item is completed.
sub CompletedItem
Returns the main configuration directory.
sub ConfigDirectory
Returns the parsed menu as an arrayref of NaturalDocs::Menu::Entry objects.
sub Content
Converts certain characters to their HTML amp char equivalents.
sub ConvertAmpChars #( text )
Replaces certain characters in the string with their entities and returns it.
sub ConvertAmpChars #( string text, int flags ) => string
Substitutes certain characters with their NDMarkup amp chars.
sub ConvertAmpChars #( text )
sub ConvertAmpChars #( text )
sub ConvertLink #( text )
Takes a relative path and converts it from the native format to a relative URL.
sub ConvertToURL #( path )
Copies a file from one path to another.
sub Copy #( source, destination ) => bool
Copies all the ignored prefix settings of the passed NaturalDocs::Languages::Base object.
sub CopyIgnoredPrefixesOf #( language )
Where possible, creates sub-groups based on directories for any long groups that have MENU_GROUP_UPDATESTRUCTURE set.
sub CreateDirectorySubGroups
Creates a directory tree corresponding to the passed path, regardless of how many directories do or do not already exist.
sub CreatePath #( path )
Converts the specified tokens into a string and returns it.
sub CreateString #( startIndex, endIndex )
Returns the directory of the CSS files.
sub CSSDirectory
What Natural Docs was doing when it crashed.
my $currentAction
The FileName for the current configuration file being parsed.
my $currentFile
Returns the SymbolString of the current interpretation, or undef if none.
sub CurrentInterpretation
Returns the current calculated package or class, or undef if none.
sub CurrentPackage
Returns the current calculated scope, or undef if global.
sub CurrentScope
Returns the score of the current interpretation, or undef if none.
sub CurrentScore
Returns the current calculated arrayref of SymbolStrings from Using statements, or undef if none.
sub CurrentUsing