Index - Natural Docs

The Gecko rendering engine, which includes Mozilla, Netscape 6+, etc.

Since the tags are generated, they will always have the following properties, which will make pattern matching much easier.

GenerateAutoFileTitles, NaturalDocs::Menu

Creates titles for the unlocked file entries in all groups that have the MENU_GROUP_UPDATETITLES flag set.

GenerateDirectoryNames, NaturalDocs::Settings

sub GenerateDirectoryNames #(hints)

Generates names for each of the input directories, which can later be retrieved with InputDirectoryNameOf().

GenerateInterpretations, NaturalDocs::SymbolTable

sub GenerateInterpretations #	(	scope,
		reference	)

Generates the list of interpretations for the passed reference.

GenerateSingularInterpretations, NaturalDocs::SymbolTable

sub GenerateSingularInterpretations #(symbol)

Generates singular interpretations of a symbol if it can be interpreted as a plural.

GenericRegexpSkip, NaturalDocs::Languages::Perl

sub GenericRegexpSkip #	(	indexRef,
		lineNumberRef,
		inBrackets	)

Advances the position one place through regexp code.

GenericRegexpSkipUntilAfter, NaturalDocs::Languages::Perl

sub GenericRegexpSkipUntilAfter #	(	indexRef,
		lineNumberRef,
		token	)

Advances the position via GenericRegexpSkip() until a specific token is reached and passed.

GenericSkip, NaturalDocs::Languages::Perl

sub GenericSkip #	(	indexRef,
		lineNumberRef	)

Advances the position one place through general code.

GenericSkipUntilAfter, NaturalDocs::Languages::Perl

sub GenericSkipUntilAfter #	(	indexRef,
		lineNumberRef,
		token	)

Advances the position via GenericSkip() until a specific token is reached and passed.

GetAllSupportedFiles, NaturalDocs::Project

sub GetAllSupportedFiles

Gets all the supported files in the passed directory and its subdirectories and puts them into supportedFiles.

GLOBAL_DEFINITION, NaturalDocs::SymbolTable::Symbol

The name of the file which defines the global version of the symbol, which is what is used if a file references the symbol but does not have its own definition.

GlobalDefinition

NaturalDocs:: SymbolTable

NaturalDocs:: SymbolTable:: Symbol

sub GlobalDefinition #	(	class,
		symbol	)

Returns the global definition of the passed symbol.

sub GlobalDefinition

Returns the file that contains the global definition of this symbol, or undef if the symbol isn’t defined.

GlobalPrototype, NaturalDocs::SymbolTable::Symbol

sub GlobalPrototype

Returns the prototype of the global definition.

GlobalSummary, NaturalDocs::SymbolTable::Symbol

sub GlobalSummary

Returns the summary of the global definition.

GlobalType, NaturalDocs::SymbolTable::Symbol

sub GlobalType

Returns the type of the global definition.

Group Functions, NaturalDocs::Menu::Entry

All of these functions assume the type is MENU_GROUP.

GroupContent, NaturalDocs::Menu::Entry

sub GroupContent

Returns an arrayref of NaturalDocs::Menu::Entry objects representing the contents of the group, or undef otherwise.

GroupIsEmpty, NaturalDocs::Menu::Entry

sub GroupIsEmpty

If the type is MENU_GROUP, returns whether the group is empty.

HandleErrors, NaturalDocs::ConfigFile

sub HandleErrors

Handles any errors that we’re found in the configuration file, which currently means printing them out in the GNU error format and annotating the configuration file with error comments.

HAS_CONTENT, NaturalDocs::Project::File

Whether the file contains Natural Docs content or not.

HasAnything, NaturalDocs::SymbolTable::File

sub HasAnything

Returns whether the file has any symbol or reference definitions at all.

hasChanged, NaturalDocs::Menu

my $hasChanged

Whether the menu changed or not, regardless of why.

HasChanged, NaturalDocs::Menu

sub HasChanged

Returns whether the menu has changed or not.

HasChildren, NaturalDocs::ClassHierarchy::Class

sub HasChildren

Returns whether any child classes are defined.

HasClass, NaturalDocs::ClassHierarchy::File

sub HasClass #(class)

Returns whether the file defines the passed class.

HasContent

NaturalDocs:: Project

NaturalDocs:: Project:: File

sub HasContent #(file)

Returns whether the file contains Natural Docs content.

sub HasContent

Returns whether the file contains Natural Docs content or not.

HasCurrentInterpretation, NaturalDocs::SymbolTable::Reference

sub HasCurrentInterpretation

Returns whether the reference has a current interpretation or not.

HasIndexes, NaturalDocs::SymbolTable

sub HasIndexes #(types)

Determines which indexes out of a list actually have content.

HasParent, NaturalDocs::ClassHierarchy::File

sub HasParent #	(	class,
		parent	)

Returns whether the file defines the passed class and parent.

HasParents, NaturalDocs::ClassHierarchy::Class

sub HasParents

Returns whether any parent classes are defined.

HasPrototype, NaturalDocs::Languages::Simple

sub HasPrototype #(type)

Returns whether the language accepts prototypes from the passed Topic Types.

HasReferences, NaturalDocs::SymbolTable::Symbol

sub HasReferences

Returns whether the symbol can be interpreted as any references.

Hidden Break.

headersOnly, NaturalDocs::Settings

my $headersOnly

Whether only the header files in C/C++ should be used.

HeadersOnly, NaturalDocs::Settings

sub HeadersOnly

Returns whether to only check the header files in C/C++.

Hook Targets, NaturalDocs::Extensions

These functions call the equivalent functions of each extension.

Hooks, NaturalDocs::Extensions::Base

Implement these functions as necessary to create your extension.

How IndexElements Work, NaturalDocs::SymbolTable::IndexElement

This is a little tricky, so make sure you understand this.

How to Add Extensions

How to Add HTML Styles

Read the CSS Guide to understand the styles Natural Docs uses and how they fit together.

How to Add Languages

In the main script add a call to NaturalDocs::Languages::Simple->New() after all the rest.

How to Add Output Formats

How to Add Topics

How to Approach, NaturalDocs::Builder::Base

Here’s an idea of how to approach making packages for different output types.

HTML Compatibility

HTML Styles