Index - Natural Docs

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.

CHEntry

A generic class entry.

Children, NaturalDocs::ClassHierarchy::Class

sub Children

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

CHILDREN, NaturalDocs::ClassHierarchy::Class

An existence hashref of children this class has.

ChildrenOf, NaturalDocs::ClassHierarchy

sub ChildrenOf #(class)

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

CHIndent

A style used to indent a level.

CHParent

The style for a parent class.

Class

NaturalDocs:: Parser:: ParsedTopic

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: ReferenceTarget

sub Class

Returns the class of the topic.

sub Class

Returns the class of the symbol, if applicable.

sub Class

Returns the target’s class, or undef if it’s global.

CLASS

NaturalDocs:: Parser:: ParsedTopic

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: ReferenceTarget

The class of the topic, if any.

The class of the symbol.

The target class, or undef if global.

Class Hierarchy Structure

Everything is contained in a single ClassHierarchy.

Class Hierarchy Styles

CLASS_HIERARCHY_FILEHANDLE, NaturalDocs::ClassHierarchy

The file handle used with ClassHierarchy.nd.

classes, NaturalDocs::ClassHierarchy

my %classes

A hash of all the classes.

Classes, NaturalDocs::ClassHierarchy::File

sub Classes

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

ClassHierarchy

The topmost style containing everything.

ClassHierarchy.nd

Stores the class hierarchy on disk.

ClassHierarchyFile, NaturalDocs::Project

sub ClassHierarchyFile

Returns thhe full path to the class hierarchy’s data file.

CleanComment, NaturalDocs::Parser

sub CleanComment #(commentLines)

Removes any extraneous formatting and whitespace from the comment.

ClearAutoTopics, NaturalDocs::Languages::Advanced

sub ClearAutoTopics

Resets the automatic topic list.

ClearScopeStack, NaturalDocs::Languages::Advanced

sub ClearScopeStack

Clears the scope stack for a new file.

ClearTokens, NaturalDocs::Languages::Advanced

sub ClearTokens

Resets the token list.

CLOSING_COMMENT_SYMBOLS, NaturalDocs::Languages::Simple

An arrayref of symbols that ends a multi-line comment.

ClosingBrowserStyles, NaturalDocs::Builder::HTMLBase

Returns the JavaScript that will close browser styles if necessary.

ClosingCommentSymbols, NaturalDocs::Languages::Simple

sub ClosingCommentSymbols

Returns an arrayref of symbols used to end a multi-line comment, or undef if none.

ClosingTag, NaturalDocs::Parser::Native

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.

Code Conventions

CommandLineOption

NaturalDocs:: Builder:: Base

NaturalDocs:: Builder:: FramedHTML

NaturalDocs:: Builder:: HTML

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.

CommandLineOptions

NaturalDocs:: Extensions

NaturalDocs:: Extensions:: Base

sub CommandLineOptions

Returns a hashref of the command line options by extension package.

sub CommandLineOptions

Use this function to return a hashref of all the command line options the extension accepts.

CompareEntries, NaturalDocs::Menu

A comparison function for use in sorting.

CONFIG_FILEHANDLE, NaturalDocs::ConfigFile

The file handle used when annotating the configuration file with error comments.

Constant Functions, NaturalDocs::Settings

ConstantOf, NaturalDocs::Topics

sub ConstantOf #(string)

Returns the Topic Types associated with the string, or undef if none.

constants, NaturalDocs::Topics

my %constants

A hash where the keys are the names in all lowercase, and the values are the Topic Types.

Constants

NaturalDocs:: Menu

NaturalDocs:: Topics

All are exported by default.

Content, NaturalDocs::Menu

sub Content

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

Content Structure

All the content of a given file is either contained in a ContentSection or a FramedContentPage.

Content Styles

ContentSection

The content section in a non-framed page.

ConvertAmpChars

NaturalDocs:: Builder:: HTMLBase

NaturalDocs:: NDMarkup

Converts certain characters to their HTML amp char equivalents.

sub ConvertAmpChars #(text)

Substitutes certain characters with their NDMarkup amp chars.

ConvertToURL, NaturalDocs::File

sub ConvertToURL #(path)

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

Copy, NaturalDocs::File

sub Copy #	(	source,
		destination	)

Copies a file from one path to another.

CParagraph

A paragraph.

CPrototype

A prototype.

CreateDirectorySubGroups, NaturalDocs::Menu

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

CreatePath, NaturalDocs::File

sub CreatePath #(path)

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

CreateString, NaturalDocs::Languages::Advanced

sub CreateString #	(	startIndex,
		endIndex	)

Converts the specified tokens into a string and returns it.

Creation Functions, NaturalDocs::Languages::Simple

CSection

A section topic.

CSS Guide

It’s important to understand the internal HTML file structure and styles in order to design your own CSS style for Natural Docs.

CTitle

The title of a topic.

CToolTip

Surrounds the entire tool tip.

CTopic

An individual topic.

CType

A type topic.

CTypeList

A type list topic.

CURRENT_INTERPRETATION, NaturalDocs::SymbolTable::Reference

The interpretation currently used as the reference target.

CurrentInterpretation, NaturalDocs::SymbolTable::Reference

sub CurrentInterpretation

Returns the symbol string of the current interpretation, or undef if none.

CurrentNamespace, NaturalDocs::Languages::Advanced

sub CurrentNamespace

Returns the current calculated namespace, or undef if none.

CurrentPackage, NaturalDocs::Languages::Advanced

sub CurrentPackage

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

CurrentProtection, NaturalDocs::Languages::Advanced

sub CurrentProtection

Returns the current protection, or undef if none.

CurrentScope, NaturalDocs::Languages::Advanced

sub CurrentScope

Returns the current calculated scope, or undef if global.

CurrentScore, NaturalDocs::SymbolTable::Reference

sub CurrentScore

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

CVariable

A variable topic.

CVariableList

A variable list topic.