Function 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::Languages::Advanced::Scope NaturalDocs::Parser::ParsedTopic NaturalDocs::SymbolTable::IndexElement
	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
	PageTitleIfFirst, NaturalDocs::Topics::Type
	Parameters, NaturalDocs::Languages::Prototype
	ParentReferenceDefinitions, NaturalDocs::ClassHierarchy::Class
	ParentReferences, NaturalDocs::ClassHierarchy::Class
	ParentReferencesOf, NaturalDocs::ClassHierarchy::File
	Parents, NaturalDocs::ClassHierarchy::Class
	ParentsOf, NaturalDocs::ClassHierarchy
	Parse, NaturalDocs::Parser
	ParseCommandLine, NaturalDocs::Settings
	ParseComment NaturalDocs::Parser::JavaDoc NaturalDocs::Parser::Native
	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
	PathIsAbsolute, NaturalDocs::File
	PerlVersion, NaturalDocs::Error
	PluralName, NaturalDocs::Topics::Type
	PreprocessFile NaturalDocs::Languages::ActionScript NaturalDocs::Languages::Advanced NaturalDocs::Languages::Perl
	PreviousIndexes, NaturalDocs::Menu
	PrintErrorsAndAnnotateFile, NaturalDocs::ConfigFile
	PrintOutputFormats, NaturalDocs::Settings
	PrintSyntax, NaturalDocs::Settings
	ProcessProperties, NaturalDocs::Languages
	ProjectDataDirectory, NaturalDocs::Settings
	ProjectDirectory, NaturalDocs::Settings
	Prototype NaturalDocs::Parser::ParsedTopic NaturalDocs::SymbolTable::IndexElement NaturalDocs::SymbolTable::ReferenceTarget NaturalDocs::SymbolTable::SymbolDefinition
	PrototypeDefinedIn, NaturalDocs::SymbolTable::Symbol
	PrototypeEndersFor, NaturalDocs::Languages::Simple
	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

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.

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.

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.

sub ParentReferenceDefinitions #( reference )

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

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.

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.

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.

sub PathIsAbsolute #( path )

Returns whether the passed path is absolute.

sub PerlVersion

Returns the current Perl version as a string.

Returns the topic’s plural name.

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.

sub PreviousIndexes

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

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.

sub ProjectDataDirectory

Returns the project data directory.

sub ProjectDirectory

Returns the project directory.

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.

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.

sub PrototypeEndersFor #( type )

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

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.