Index - Natural Docs

Obscure, NaturalDocs::ConfigFile

sub Obscure #(text)

Obscures the passed text so that it is not user editable and returns it.

OnClass, NaturalDocs::Parser

sub OnClass #(class)

A function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a class declaration.

OnClassParent, NaturalDocs::Parser

sub OnClassParent #	(	class,
		parent,
		protection	)

A function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a declaration of inheritance.

OnCode, NaturalDocs::Languages::Simple

sub OnCode #	(	codeLines,
		codeLineNumber, topicList,
		lastCommentTopicCount	)

Called whenever a section of code is encountered by the parser.

OnComment, NaturalDocs::Parser

sub OnComment #	(	commentLines,
		lineNumber	)

The function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a comment suitable for documentation.

OnDefaultTitleChange, NaturalDocs::Menu

sub OnDefaultTitleChange #(file)

Called by NaturalDocs::Project if the default menu title of a source file has changed.

OnFileChange, NaturalDocs::Menu

sub OnFileChange

Called by NaturalDocs::Project if it detects that the menu file has changed.

OPENING_COMMENT_SYMBOLS, NaturalDocs::Languages::Simple

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

OpeningBrowserStyles, NaturalDocs::Builder::HTMLBase

Returns the JavaScript that will add opening browser styles if necessary.

OpeningCommentSymbols, NaturalDocs::Languages::Simple

sub OpeningCommentSymbols

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

Opera 5.x.

Opera 6.x.

Opera 7.x

Optional Interface Functions, NaturalDocs::Builder::Base

These functions can be implemented but packages are not required to do so.

OutputDirectoryOf, NaturalDocs::Settings

sub OutputDirectoryOf #(object)

Returns the output directory of a builder object.

OutputFileOf, NaturalDocs::Builder::HTMLBase

Returns the output file name of the source file.

OutputPackageOf, NaturalDocs::Builder

sub OutputPackageOf #(commandLineOption)

Returns the output package corresponding to the passed command line option, or undef if none.

outputPackages, NaturalDocs::Builder

my @outputPackages

An array of the output packages available for use.

OutputPackages, NaturalDocs::Builder

sub OutputPackages

Returns an arrayref of the output packages available for use.

OutputStyleOf, NaturalDocs::Settings

sub OutputStyleOf #(object)

Returns the style associated with a builder object.