Index - Natural Docs

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

P
	package, NaturalDocs::Parser::Native
	Package NaturalDocs::Languages::Advanced::Scope NaturalDocs::Parser::ParsedTopic NaturalDocs::SymbolTable::IndexElement
	PACKAGE Modules\NaturalDocs\Languages\Advanced\Scope.pm Modules\NaturalDocs\Parser\ParsedTopic.pm Modules\NaturalDocs\SymbolTable\IndexElement.pm
	Package Variables NaturalDocs::Builder::HTMLBase NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp
	PACKAGE_SEPARATOR
	PackageSeparator NaturalDocs::Languages::ActionScript NaturalDocs::Languages::Base NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl NaturalDocs::Languages::Simple NaturalDocs::SymbolTable::IndexElement
	PackageSeparatorWasSet NaturalDocs::Languages::Base NaturalDocs::Languages::Simple
	PAfterParameters
	Page Structure
	Page Styles
	PAGE_TITLE_IF_FIRST
	PageTitleIfFirst, NaturalDocs::Topics::Type
	Parameters, NaturalDocs::Languages::Prototype
	PARENT_REFERENCES
	ParentReferenceDefinitions, NaturalDocs::ClassHierarchy::Class
	parentReferences, NaturalDocs::ClassHierarchy
	ParentReferences, NaturalDocs::ClassHierarchy::Class
	ParentReferencesOf, NaturalDocs::ClassHierarchy::File
	Parents, NaturalDocs::ClassHierarchy::Class
	PARENTS
	ParentsOf, NaturalDocs::ClassHierarchy
	Parse, NaturalDocs::Parser
	ParseCommandLine, NaturalDocs::Settings
	ParseComment NaturalDocs::Parser::JavaDoc NaturalDocs::Parser::Native
	parsedFile, NaturalDocs::Parser
	ParseFile NaturalDocs::Languages::ActionScript NaturalDocs::Languages::Base NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl NaturalDocs::Languages::Simple
	ParseForBuild, NaturalDocs::Parser
	ParseForCommentsAndTokens, NaturalDocs::Languages::Advanced
	ParseForInformation, NaturalDocs::Parser
	ParseHeaderLine, NaturalDocs::Parser::Native
	ParseParameterLine NaturalDocs::Languages::ActionScript NaturalDocs::Languages::Ada NaturalDocs::Languages::Base NaturalDocs::Languages::Pascal NaturalDocs::Languages::PLSQL NaturalDocs::Languages::Tcl
	ParsePascalParameterLine, NaturalDocs::Languages::Base
	ParsePrototype NaturalDocs::Languages::Base NaturalDocs::Languages::PLSQL NaturalDocs::Languages::Tcl
NaturalDocs::	Parser
NaturalDocs::	Parser::JavaDoc
NaturalDocs::	Parser::Native
NaturalDocs::	Parser::ParsedTopic
	Parsing Functions NaturalDocs::Languages::Advanced NaturalDocs::Languages::Base NaturalDocs::Languages::Simple
	parsingForInformation, NaturalDocs::Parser
	pastFirstBrace, NaturalDocs::Languages::Tcl
	Path String Functions, NaturalDocs::File
	PathIsAbsolute, NaturalDocs::File
	PBeforeParameters
	PDefaultValue
	PDefaultValuePrefix
	PerlVersion, NaturalDocs::Error
	PLURAL_NAME
	pluralKeywords, NaturalDocs::Topics
	PluralName, NaturalDocs::Topics::Type
	PopupSearchResultsPage
	Post Processing
	PParameter
	PParameterPrefix
	Preamble
	prebuiltMenus, NaturalDocs::Builder::HTMLBase
	Preparation and Differentiation
	PreprocessFile NaturalDocs::Languages::ActionScript NaturalDocs::Languages::Advanced NaturalDocs::Languages::Perl
	PREVIOUS_SETTINGS_FILEHANDLE, NaturalDocs::Settings
	previousIndexes, NaturalDocs::Menu
	PreviousIndexes, NaturalDocs::Menu
	PreviousMenuState.nd
	PreviousSettings.nd
	PrintErrorsAndAnnotateFile, NaturalDocs::ConfigFile
	PrintOutputFormats, NaturalDocs::Settings
	PrintSyntax, NaturalDocs::Settings
	Processing Functions, NaturalDocs::Parser
	ProcessProperties, NaturalDocs::Languages
	Programming Notes, NaturalDocs::ImageReferenceTable
NaturalDocs::	Project
NaturalDocs::	Project::ImageFile
NaturalDocs::	Project::SourceFile
	ProjectDataDirectory, NaturalDocs::Settings
	projectDirectory, NaturalDocs::Settings
	ProjectDirectory, NaturalDocs::Settings
	Prototype Global NaturalDocs::Parser::ParsedTopic NaturalDocs::SymbolTable::IndexElement NaturalDocs::SymbolTable::ReferenceTarget NaturalDocs::SymbolTable::SymbolDefinition
	PROTOTYPE Modules\NaturalDocs\Parser\ParsedTopic.pm Modules\NaturalDocs\SymbolTable\IndexElement.pm Modules\NaturalDocs\SymbolTable\ReferenceTarget.pm Modules\NaturalDocs\SymbolTable\SymbolDefinition.pm
	Prototype Parameter Styles
	Prototype Structure
	Prototype Styles
	PrototypeDefinedIn, NaturalDocs::SymbolTable::Symbol
	prototypeDirectives, NaturalDocs::Languages::Pascal
	PrototypeEndersFor, NaturalDocs::Languages::Simple
	Prototypes and Tooltips
	PType
	PTypePrefix
	Purge NaturalDocs::ClassHierarchy NaturalDocs::SymbolTable
	PurgeDeletedSourceFiles, NaturalDocs::SourceDB
	PurgeFiles NaturalDocs::Builder::Base NaturalDocs::Builder::HTMLBase
	PurgeImages NaturalDocs::Builder::Base NaturalDocs::Builder::HTMLBase
	PurgeIndexes NaturalDocs::Builder::Base NaturalDocs::Builder::HTMLBase NaturalDocs::SymbolTable
	PurgeIndexFiles, NaturalDocs::Builder::HTMLBase
	PurgeResolvingInfo, NaturalDocs::SymbolTable
	PushToGroup, NaturalDocs::Menu::Entry

my $package

A SymbolString representing the package normal topics will be a part of at the current point in the file.

sub Package

Returns the package SymbolString of the scope, or undef if none.

sub Package

Returns the package SymbolString that the topic appears in.

sub HasMultiplePackages

If HasMultiplePackages() is true, returns an arrayref of NaturalDocs::SymbolTable::IndexElement objects.

The package SymbolString of the scope.

These variables are shared by all instances of the package so don’t change them.

The combined package separator symbol of the element.

sub PackageSeparator

Returns the package separator symbol.

sub PackageSeparator

Returns the language’s package separator string.

sub PackageSeparator

Returns the package separator symbol.

sub PackageSeparator

Returns the package separator symbol.

sub SetPackageSeparator #( separator )

Returns the package separator symbol.

Returns the combined package separator symbol of the element.

sub PackageSeparatorWasSet

Returns whether the language’s package separator string was ever changed from the default.

Returns whether the package separator symbol was ever changed from the default.

The part of the prototype that comes after the parameters.

The body tag is used to distinguish between the types of pages.

Whether the topic becomes the page title if it’s first in a file.

Returns whether the topic becomes the page title if it’s first in the file.

Returns the parameter list as an arrayref of NaturalDocs::Languages::Prototype::Parameters, or undef if none.

A hashref of the parent ReferenceStrings this class has.

sub ParentReferenceDefinitions #( reference )

Returns an array of the FileNames which define the passed parent ReferenceString, or an empty array if none.

my %parentReferences

A hash of all the parent reference strings and what they resolve to.

sub ParentReferences

Returns an array of the parent ReferenceStrings, or an empty array if none.

sub ParentReferencesOf #( class )

Returns an array of the parent ReferenceStrings that are defined by the class, or an empty array if none.

sub Parents

Returns an array of the parent SymbolStrings, or an empty array if none.

An existence hashref of the SymbolStrings of all the parents this class has.

sub ParentsOf #( class )

Returns a SymbolString array of the passed class’ parents, or an empty array if none.

sub Parse

Opens the source file and parses process.

sub ParseCommandLine

Parses and validates the command line.

sub ParseComment #( string[] commentLines,
bool isJavaDoc,
int lineNumber,
ParsedTopics[] * parsedTopics )

Parses the JavaDoc-syntax comment and adds it to the parsed topic list.

sub ParseComment #( commentLines,
isJavaDoc,
lineNumber,
parsedTopics )

This will be called whenever a comment capable of containing Natural Docs content is found.

my @parsedFile

An array of NaturalDocs::Parser::ParsedTopic objects.

sub ParseFile #( sourceFile,
topicsList )

Parses the passed source file, sending comments acceptable for documentation to NaturalDocs::Parser->OnComment().

sub ParseFile #( sourceFile,
topicsList )

Parses the passed source file, sending comments acceptable for documentation to NaturalDocs::Parser->OnComment().

sub ParseFile #( sourceFile,
topicsList )

Parses the passed source file, sending comments acceptable for documentation to NaturalDocs::Parser->OnComment().

sub ParseFile #( sourceFile,
topicsList )

Parses the passed source file, sending comments acceptable for documentation to NaturalDocs::Parser->OnComment() and all other sections to OnCode().

sub ParseForBuild #( file )

Parses the input file for building, returning it as a NaturalDocs::Parser::ParsedTopic arrayref.

sub ParseForCommentsAndTokens #( FileName sourceFile,
string[] lineCommentSymbols,
string[] blockCommentSymbols,
string[] javadocLineCommentSymbols,
string[] javadocBlockCommentSymbols )

Loads the passed file, sends all appropriate comments to NaturalDocs::Parser->OnComment(), and breaks the rest into an arrayref of tokens.

sub ParseForInformation #( file )

Parses the input file for information.

sub ParseHeaderLine #( line )

If the passed line is a topic header, returns the array ( keyword, title ).

sub ParseParameterLine #( line )

Parses a prototype parameter line and returns it as a NaturalDocs::Languages::Prototype::Parameter object.

sub ParseParameterLine #( ... )

Overridden because Ada uses Pascal-style parameters

sub ParseParameterLine #( line )

Parses a prototype parameter line and returns it as a NaturalDocs::Languages::Prototype::Parameter object.

sub ParseParameterLine #( ... )

sub ParseParameterLine #( line )

Parses a prototype parameter line and returns it as a NaturalDocs::Languages::Prototype::Parameter object.

sub ParseParameterLine #( line )

Parses a prototype parameter line and returns it as a NaturalDocs::Languages::Prototype::Parameter object.

sub ParsePascalParameterLine #( line )

Parses a Pascal-like prototype parameter line and returns it as a NaturalDocs::Languages::Prototype::Parameter object.

sub ParsePrototype #( type,
prototype )

Parses the prototype and returns it as a NaturalDocs::Languages::Prototype object.

sub ParsePrototype #( type,
prototype )

Overridden to handle Microsoft’s parenthesisless version.

sub ParsePrototype #( type,
prototype )

Parses the prototype and returns it as a NaturalDocs::Languages::Prototype object.

A package that coordinates source file parsing between the NaturalDocs::Languages::Base-derived objects and its own sub-packages such as NaturalDocs::Parser::Native.

A package for translating JavaDoc topics into Natural Docs.

A package that converts comments from Natural Docs’ native format into NaturalDocs::Parser::ParsedTopic objects.

A class for parsed topics of source files.

These functions are good general language building blocks.

my $parsingForInformation

Whether ParseForInformation() was called.

my $pastFirstBrace

Whether we’ve past the first brace in a function prototype or not.

sub PathIsAbsolute #( path )

Returns whether the passed path is absolute.

The part of the prototype that comes before the parameters.

The default value expression for a parameter.

The prefix of the default value expression.

sub PerlVersion

Returns the current Perl version as a string.

The topic’s plural name.

my %pluralKeywords

A hashref that maps all-lowercase plural keywords to their TopicTypes.

Returns the topic’s plural name.

A search results page for use in a popup iframe.

After all the comments have been parsed into ParsedTopics and execution has been returned to NaturalDocs::Parser->Parse(), it’s time for some after the fact cleanup.

The parameter name.

The prefix of a parameter name.

The licenses for most software are designed to take away your freedom to share and change it.

my %prebuiltMenus

A hash that maps output directonies to menu HTML already built for it.

NaturalDocs::Parser->Parse() can be called from one of two places, NaturalDocs::Parser->ParseForInformation() and NaturalDocs::Parser->ParseForBuild(), which correspond to the parsing and building phases of Natural Docs.

sub PreprocessFile

If the file is escaped, strips out all unescaped code.

sub PreprocessFile #( lines )

An overridable function if you’d like to preprocess the file before it goes into ParseForCommentsAndTokens().

sub PreprocessFile #( lines )

Overridden to support “=begin nd” and similar.

The file handle used with PreviousSettings.nd.

my %previousIndexes

An existence hash of all the index TopicTypes that appeared in the menu last time.

sub PreviousIndexes

Returns an existence hashref of all the index TopicTypes that previously appeared in the menu.

The file used to store the previous state of the menu so as to detect changes.

Stores the previous command line settings.

sub PrintErrorsAndAnnotateFile

Prints the errors to STDERR in the standard GNU format and annotates the configuration file with them.

sub PrintOutputFormats #( prefix )

Prints all the possible output formats that can be specified with -o.

sub PrintSyntax

Prints the syntax reference.

sub ProcessProperties #( properties,
version,
tempExtensions,
tempShebangStrings )

Processes an array of language properties from Languages.txt.

When working on this code, remember that there are three things it has to juggle.

A package that manages information about the files in the source tree, as well as the list of files that have to be parsed and built.

A simple information class about project image files.

A simple information class about project files.

sub ProjectDataDirectory

Returns the project data directory.

my $projectDirectory

The project directory.

sub ProjectDirectory

Returns the project directory.

The style encompassing the entire prototype.

sub Prototype

Returns the prototype if one is defined.

Returns the prototype of the package/symbol/file, if applicable.

sub Prototype

Returns the target’s prototype, or undef if not defined or not applicable.

sub Prototype

Returns the definition’s prototype, or undef if it doesn’t have one.

The prototype, if it exists and is applicable.

Everything is enclosed in a Prototype.

sub PrototypeDefinedIn #( file )

Returns the prototype of symbol defined in the passed FileName, or undef if it doesn’t exist or is not defined in that file.

my %prototypeDirectives

An existence hash of all the directives that can appear after a function prototype and will be included.

sub PrototypeEndersFor #( type )

Returns an arrayref of prototype ender symbols for the passed TopicType, or undef if none.

Hover over NaturalDocs::Parser::JavaDoc->ParseComment() and NaturalDocs::Parser::JavaDoc->IsMine()

The parameter type.

The prefix of a parameter type.

sub Purge

Purges the hierarchy of files that no longer have Natural Docs content.

sub Purge

Purges the symbol table of all symbols and references from files that no longer have Natural Docs content.

sub PurgeDeletedSourceFiles

Removes all data associated with deleted source files.

sub PurgeFiles #( files )

Define this function to make the package remove all output related to the passed files.

sub PurgeFiles #( filesToPurge )

Deletes the output files associated with the purged source files.

sub PurgeImages #( files )

Define this function to make the package remove all output related to the passed image files.

sub PurgeImages #( files )

Define this function to make the package remove all output related to the passed image files.

sub PurgeIndexes #( indexes )

Define this function to make the package remove all output related to the passed indexes.

sub PurgeIndexes #( indexes )

Deletes the output files associated with the purged source files.

sub PurgeIndexes

Clears all generated indexes.

sub PurgeIndexFiles #(
    TopicType type,
    optional NaturalDocs::SymbolTable:: IndexElement[] indexSections,
    optional int startingPage
)

Removes all or some of the output files for an index.

sub PurgeResolvingInfo

Purges unnecessary information from the symbol table after it is fully resolved.

sub PushToGroup #( entry )

Pushes the entry to the end of the group content.