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
M
MakeAutoGroups, NaturalDocs::Parser
sub MakeAutoGroups
Creates group topics for files that do not have them.
MakeAutoGroupsFor, NaturalDocs::Parser
sub MakeAutoGroupsFor #(startIndex,
endIndex)
Creates group topics for sections of files that do not have them.
MakeIndex, NaturalDocs::SymbolTable
sub MakeIndex #(type)
Generates a symbol index.
MakeParsedTopic, NaturalDocs::Parser::Native
sub MakeParsedTopic #(name,
class,
type,
body,
lineNumber)
Creates a NaturalDocs::Parser::ParsedTopic object for the passed parameters.
MakeReferenceString, NaturalDocs::SymbolTable
sub MakeReferenceString #(scope,
reference)
Encodes the reference information as a string.
MakeRelativePath, NaturalDocs::File
sub MakeRelativePath #(basePath,
targetPath)
Takes two paths and returns a relative path between them.
MakeRelativeURL, NaturalDocs::Builder::HTMLBase
Returns a relative path between two files in the output tree and returns it in URL format.
sub MakeSortableSymbol #(name,
type)
Returns the symbol that should be used for sorting.
sub MakeSortableSymbol #(name,
type)
Perl’s variables start with symbols: $ for scalars, @ for arrays, and % for hashes.
sub MakeSortableSymbol #(name,
type)
PHP’s variables start with dollar signs.
sub MakeSortableSymbol #(name,
type)
Ruby’s variables may start with symbols: none for local, $ for global, @ for instance, and @@ for class.
MakeSymbolString, NaturalDocs::SymbolTable
sub MakeSymbolString #(class,
symbol)
Encodes the symbol information as a string.
MarkEndOfOriginal, NaturalDocs::Menu::Entry
sub MarkEndOfOriginal
If the group doesn’t already have one, adds a MENU_ENDOFORIGINAL entry to the end and sets the MENU_GROUP_HASENDOFORIGINAL flag.
MatchDirectoriesAndGroups, NaturalDocs::Menu
sub MatchDirectoriesAndGroups
Determines which groups files in certain directories should be placed in.
MenuBackupFile, NaturalDocs::Project
sub MenuBackupFile
Returns the full path to the project’s menu backup file, which is used to save the original menu in some situations.
MenuFile, NaturalDocs::Project
sub MenuFile
Returns the full path to the project’s menu file.
MenuToggleJavaScript, NaturalDocs::Builder::HTMLBase
Returns the JavaScript necessary to expand and collapse the menus.
Merge, NaturalDocs::SymbolTable::IndexElement
sub Merge #(class,
file,
type,
prototype,
summary)
Adds another definition of the same symbol.
MergeAutoTopics, NaturalDocs::Parser
sub MergeAutoTopics #(language,
autoTopics)
Merges the automatically generated topics into the file.
MergeFile, NaturalDocs::SymbolTable::IndexElement
sub MergeFile #(file,
type,
prototype,
summary)
Adds another definition of the same class/symbol.
MigrateOldFiles, NaturalDocs::Project
sub MigrateOldFiles
If the project uses the old file names used prior to 1.14, it converts them to the new file names.
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.
NameOf, NaturalDocs::Topics
sub NameOf #(topic)
Returns the name string of the passed constant.
Namespace, NaturalDocs::Languages::Advanced::Scope
sub Namespace
Returns the namespace of the scope, or undef if none.
NDMarkupToHTML, NaturalDocs::Builder::HTMLBase
Converts a block of NDMarkup to HTML.
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.
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 ‘.’