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

N
	name, SearchPanel
	Name NaturalDocs::Languages::Base NaturalDocs::Languages::Prototype::Parameter NaturalDocs::Topics::Type
	NAME Modules\NaturalDocs\Languages\Prototype\Parameter.pm Modules\NaturalDocs\Topics\Type.pm
	NAME_PREFIX
	Named Directories, NaturalDocs::Settings
	NameInfo, NaturalDocs::Topics
	NameOfType, NaturalDocs::Topics
	NamePrefix, NaturalDocs::Languages::Prototype::Parameter
	names, NaturalDocs::Topics
	Native Comment Parsing
	NaturalDocs
	NDMarkup
NaturalDocs::	NDMarkup
	NDMarkupToHTML, NaturalDocs::Builder::HTMLBase
	NDMarkupToHTML Styles
	NDMARKUPTOHTML_GENERAL
	NDMARKUPTOHTML_SUMMARY
	NDMARKUPTOHTML_TOOLTIP
	New NaturalDocs::Builder::Base NaturalDocs::Builder::HTMLBase NaturalDocs::ClassHierarchy::Class NaturalDocs::ClassHierarchy::File NaturalDocs::Languages::Advanced NaturalDocs::Languages::Advanced::Scope NaturalDocs::Languages::Advanced::ScopeChange NaturalDocs::Languages::Base NaturalDocs::Languages::Prototype NaturalDocs::Languages::Prototype::Parameter NaturalDocs::Languages::Simple NaturalDocs::Menu::Entry NaturalDocs::Parser::ParsedTopic NaturalDocs::Project::ImageFile NaturalDocs::Project::SourceFile NaturalDocs::Settings::BuildTarget NaturalDocs::SourceDB::File NaturalDocs::SourceDB::Item NaturalDocs::SourceDB::WatchedFileDefinitions NaturalDocs::SymbolTable::File NaturalDocs::SymbolTable::IndexElement NaturalDocs::SymbolTable::Reference NaturalDocs::SymbolTable::ReferenceTarget NaturalDocs::SymbolTable::Symbol NaturalDocs::SymbolTable::SymbolDefinition NaturalDocs::Topics::Type
	noAutoGroup, NaturalDocs::Settings
	NoAutoGroup, NaturalDocs::Settings
	NoExtension, NaturalDocs::File
	NoFileName, NaturalDocs::File
	NormalizePrototype, NaturalDocs::Languages::Base
	Notes, NaturalDocs::Builder::Base
	NoUpwards, NaturalDocs::File

this.name

The name of the global variable that will be storing this instance of the class.

Returns the language’s name.

The parameter name.

Returns the topic name.

The parameter name.

The parameter name prefix which should be aligned separately, if any.

Ever since Natural Docs introduced multiple input directories in 1.16, they’ve had to be named.

sub NameInfo #( name )

Returns information about a topic name.

sub NameOfType #( topicType,
plural,
alphanumericOnly )

Returns the name of the passed TopicType, or undef if it doesn’t exist.

The parameter name prefix, which should be aligned separately, if any.

my %names

A hashref that maps various forms of the all-lowercase type names to TopicTypes.

At this point, parsing is handed off to NaturalDocs::Parser::Native->ParseComment().

Version 1.4

A markup format used by the parser, both internally and in NaturalDocs::Parser::ParsedTopic objects.

A package of support functions for dealing with NDMarkup.

sub NDMarkupToHTML #( sourceFile,
text,
symbol,
package,
type,
using,
style )

Converts a block of NDMarkup to HTML.

These are the styles used with NDMarkupToHTML().

General style.

For summaries.

For tooltips.

sub New

Creates and returns a new object.

sub New

Creates and returns a new object.

sub New

Creates and returns a new class.

sub New

Creates and returns a new class.

sub New #( name )

Creates and returns a new object.

sub New #( closingSymbol,
package,
using )

Creates and returns a new object.

sub New #( scope,
lineNumber )

Creates and returns a new object.

sub New #( name )

Creates and returns a new object.

sub New #( beforeParameters,
afterParameters )

Creates and returns a new prototype object.

sub New #( type,
typePrefix,
name,
namePrefix,
defaultValue,
defaultValuePrefix )

Creates and returns a new prototype object.

sub New #( name )

Creates and returns a new object.

sub New #( type,
title,
target,
flags )

Creates and returns a new object.

sub New #( type,
title,
package,
using,
prototype,
summary,
body,
lineNumber,
isList )

Creates a new object.

sub New #( timestamp lastModified,
FileStatus status,
bool wasUsed )

Creates and returns a new file object.

sub New #( hasContent,
lastModified,
status,
defaultMenuTitle )

Creates and returns a new file object.

sub New #( builder,
directory )

Creates and returns a new object.

sub New

Returns a new object.

sub New

Creates and returns a new object.

sub New

Creates and returns a new object.

sub New

Creates and returns a new object.

sub New #( symbol,
package,
file,
type,
prototype,
summary,
combinedType,
packageSeparator )

Returns a new object.

sub New

Creates and returns a new object.

sub New #( symbol,
file,
type,
prototype,
summary )

Creates and returns a new object.

sub New

Creates and returns a new object.

sub New #( type,
prototype,
summary )

Creates and returns a new object.

sub New #( name,
pluralName,
index,
scope,
pageTitleIfFirst,
breakLists )

Creates and returns a new object.

my $noAutoGroup

Whether auto-grouping is turned off.

sub NoAutoGroup

Returns whether auto-grouping is turned off.

sub NoExtension #( path )

Returns the path without an extension.

sub NoFileName #( path )

Takes a path and returns a version without the file name.

sub NormalizePrototype #( prototype )

Normalizes a prototype.

sub NoUpwards #( array )

Takes an array of directory entries and returns one without all the entries that refer to the parent directory, such as ‘.’