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
Returns the name of the language.
sub Name
Returns the language’s name.
sub Name
Returns the name of the language.
sub Name
Returns the name of the topic.
sub Name
Returns the target’s name.
The name of the language.
The name of the topic.
The name of the target.
NameOf, NaturalDocs::Topics
sub NameOf #(topic)
Returns the name string of the passed constant.
names, NaturalDocs::Topics
my @names
An array of the topic names.
Namespace, NaturalDocs::Languages::Advanced::Scope
sub Namespace
Returns the namespace of the scope, or undef if none.
NAMESPACE, NaturalDocs::Languages::Advanced::Scope
The namespace of the scope, if applicable.
Version 1.2
A package that takes parsed source file and builds the output for it.
A base class for all Builder output formats.
A package that generates output in HTML with frames.
A package that generates output in HTML.
A base package for all the shared functionality in NaturalDocs::Builder::HTML and NaturalDocs::Builder::FramedHTML.
A package that handles all the gory details of managing the class hierarchy.
An object that stores information about a class in the hierarchy.
An object that stores information about what hierarchy information is present in a file.
A package to manage some of the shared functionality needed for Natural Docs’ configuration files.
Constants that are used throughout the script.
A custom Perl pragma to define member constants for use in Natural Docs objects.
A package to manage all the extensions to Natural Docs.
A base package for all Natural Docs extensions.
A package to manage file access across platforms.
A package to manage all the programming languages Natural Docs supports.
A subclass to handle the language variations of Pascal and Delphi.
The base class for all languages that have full support in Natural Docs.
A class used to store a scope level.
A class used to store a scope change.
A base class for all programming language parsers.
A subclass to handle the language variations of Pascal and Delphi.
A subclass to handle the language variations of Perl.
A subclass to handle the language variations of PHP.
A subclass to handle the language variations of PL/SQL.
A subclass to handle the language variations of Ruby.
A class containing the characteristics of a particular programming language for basic support within Natural Docs.
A subclass to handle the language variations of Tcl.
A package handling the menu’s contents and state.
A class representing an entry in the menu.
A package of support functions for dealing with NDMarkup.
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 that converts comments from Natural Docs’ native format into NaturalDocs::Parser::ParsedTopic objects.
A class for parsed topics of source files.
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 files.
A package to handle the command line and various other program settings.
A class that stores information about a build target.
A package that handles all the gory details of managing symbols.
A class representing a file, keeping track of what symbols and references are defined in it.
A class representing part of an indexed symbol.
A class representing a symbol or a potential symbol.
A class for storing information about a reference target.
A class representing a symbol or a potential symbol.
A class representing a symbol definition.
The topic constants and functions to convert them to and from strings used throughout the script.
A package for handling version information.
A markup format used by the parser, both internally and in NaturalDocs::Parser::ParsedTopic objects.
NDMarkupToHTML, NaturalDocs::Builder::HTMLBase
Converts a block of NDMarkup to HTML.
Need More?, NaturalDocs::Extensions::Base
If you need another hook for your extension, contact Natural Docs’ Maintainer.
The pre-Gecko Netscape rendering engine, which is 4.x and earlier.
Netscape 4.x.
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
Returns a new language object and adds it to NaturalDocs::Languages.
sub New #(symbol,
namespace,
package,
protection)
Creates and returns a new object.
sub New #(scope,
lineNumber)
Creates and returns a new object.
sub New
Creates and returns a new object.
sub New #(name,
extensions,
shebangStrings,
lineCommentSymbols,
openingCommentSymbols,
closingCommentSymbols,
functionEnders,
variableEnders,
lineExtender)
Returns a new language object and adds it to NaturalDocs::Languages.
sub New #(type,
title,
target,
flags)
Creates and returns a new object.
sub New #(type,
name,
class,
scope,
prototype,
summary,
body,
lineNumber)
Creates a new object.
sub New #(hasContent,
lastModified,
status,
defaultMenuTitle)
Creates and returns a new file object.
sub New #(name,
builder,
directory,
style)
Creates and returns a new object.
sub New
Creates and returns a new object.
sub New #(symbol,
class,
file,
type,
prototype,
summary)
Returns a new object.
sub New
Creates and returns a new object.
sub New #(class,
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.
NoFileName, NaturalDocs::File
sub NoFileName #(path)
Takes a path and returns a version without the file name.
NonListConstantOf, NaturalDocs::Topics
sub NonListConstantOf #(string)
Returns the Topic Types associated with the string, or undef if none.
Notes, NaturalDocs::Builder::Base
NoUpwards, NaturalDocs::File
sub NoUpwards #(array)
Takes an array of directory entries and returns one without all the entries that refer to the parent directory, such as ‘.’