Index - Natural Docs

Greg Valure (gregvalure@naturaldocs.org)

MakeAutoGroups, NaturalDocs::Parser

sub MakeAutoGroups

Creates group topics for files that do not have them.

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.

MakeSortableSymbol

NaturalDocs:: Languages:: Base

NaturalDocs:: Languages:: Perl

NaturalDocs:: Languages:: PHP

NaturalDocs:: Languages:: Ruby

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.

MAXFILESINGROUP, NaturalDocs::Menu

The maximum number of file entries that can be present in a group before it becomes a candidate for sub-grouping.

Members

NaturalDocs:: ClassHierarchy:: Class

NaturalDocs:: Languages:: Advanced

NaturalDocs:: Languages:: Simple

NaturalDocs:: Menu:: Entry

NaturalDocs:: Parser:: ParsedTopic

NaturalDocs:: Project:: File

NaturalDocs:: Settings:: BuildTarget

NaturalDocs:: SymbolTable:: File

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: Reference

NaturalDocs:: SymbolTable:: ReferenceTarget

NaturalDocs:: SymbolTable:: Symbol

NaturalDocs:: SymbolTable:: SymbolDefinition

The class is implemented as a blessed arrayref.

The object is implemented as a blessed arrayref with the indexes below.

The object is a blessed arrayref with the following indexes.

The class is implemented as a blessed arrayref.

The class is implemented as a blessed arrayref with the members below.

The class is implemented as a blessed arrayref.

MEntry

The parent container of MFile and MGroup entries.

menu, NaturalDocs::Menu

my $menu

The parsed menu file.

Menu Entry Flags, NaturalDocs::Constants

The various flags that can apply to a menu entry.

Menu Entry Types, NaturalDocs::Constants

Constants representing all the types of sections that can appear in the menu file.

Menu Length Constants, NaturalDocs::Builder::HTMLBase

Constants used to approximate the lengths of the menu or its groups.

Menu Package Variables, NaturalDocs::Builder::HTMLBase

These variables are for the menu generation functions only.

Menu Structure

Everything is enclosed in a MenuSection or a FramedMenuPage.

Menu Styles

Menu.txt

The file used to generate the menu.

MENU_DATA, NaturalDocs::Constants

Data not meant for user editing.

MENU_ENDOFORIGINAL, NaturalDocs::Constants

A dummy entry that marks where the original group content ends.

MENU_FILE, NaturalDocs::Constants

A source file, relative to the source directory.

MENU_FILE_NOAUTOTITLE, NaturalDocs::Constants

Whether the file is auto-titled or not.

MENU_FILELENGTH, NaturalDocs::Builder::HTMLBase

The length of one file entry.

MENU_FOOTER, NaturalDocs::Constants

Footer text.

MENU_FORMAT, NaturalDocs::Constants

The version of Natural Docs the menu file was generated with.

MENU_GROUP, NaturalDocs::Constants

A group.

MENU_GROUP_EVERYTHINGSORTED, NaturalDocs::Constants

All entries in the group are sorted alphabetically.

MENU_GROUP_FILESANDGROUPSSORTED, NaturalDocs::Constants

The group’s files and sub-groups are sorted alphabetically.

MENU_GROUP_FILESSORTED, NaturalDocs::Constants

The group’s files are sorted alphabetically.

MENU_GROUP_HASENDOFORIGINAL, NaturalDocs::Constants

Whether the group contains a dummy MENU_ENDOFORIGINAL entry.

MENU_GROUP_ISINDEXGROUP, NaturalDocs::Constants

Whether the group is used primarily for MENU_INDEX entries.

MENU_GROUP_UNSORTED, NaturalDocs::Constants

The group’s contents are not sorted.

MENU_GROUP_UPDATEORDER, NaturalDocs::Constants

The group should be resorted.

MENU_GROUP_UPDATESTRUCTURE, NaturalDocs::Constants

The group should be checked for structural changes, such as being removed or being split into subgroups.

MENU_GROUP_UPDATETITLES, NaturalDocs::Constants

The group should have its auto-titles regenerated.

MENU_GROUPLENGTH, NaturalDocs::Builder::HTMLBase

The length of one group entry.

MENU_INDEX, NaturalDocs::Constants

An index.

MENU_LENGTHLIMIT, NaturalDocs::Builder::HTMLBase

The limit of the menu’s length.

MENU_LINK, NaturalDocs::Constants

A web link.

MENU_LINKLENGTH, NaturalDocs::Builder::HTMLBase

The length of one link entry.

MENU_SUBTITLE, NaturalDocs::Constants

The sub-title of the menu.

MENU_SUBTITLELENGTH, NaturalDocs::Builder::HTMLBase

The length of the subtitle.

MENU_TEXT, NaturalDocs::Constants

Arbitrary text.

MENU_TEXTLENGTH, NaturalDocs::Builder::HTMLBase

The length of one text entry.

MENU_TITLE, NaturalDocs::Constants

The title of the menu.

MENU_TITLELENGTH, NaturalDocs::Builder::HTMLBase

The length of the title.

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.

menuGroupLengths, NaturalDocs::Builder::HTMLBase

my %menuGroupLengths

A hash of the length of each group, not including any subgroup contents.

menuGroupNumber, NaturalDocs::Builder::HTMLBase

my $menuGroupNumber

The current menu group number.

menuGroupNumbers, NaturalDocs::Builder::HTMLBase

my %menuGroupNumbers

A hash of the number of each group, as managed by menuGroupNumber.

menuLength, NaturalDocs::Builder::HTMLBase

my $menuLength

The length of the entire menu, fully expanded.

MenuSection

The menu section in a non-framed page.

menuSelectionHierarchy, NaturalDocs::Builder::HTMLBase

my @menuSelectionHierarchy

An array of the NaturalDocs::Menu::Entry objects of each group surrounding the selected menu item.

menuSynonyms, NaturalDocs::Menu

my %menuSynonyms

A hash of the text synonyms for the menu tokens.

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.

MFile

A file entry.

MGroup

A group entry.

MGroupContent

A container for a MGroup’s content.

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.

MINFILESINNEWGROUP, NaturalDocs::Menu

The minimum number of file entries that must be present in a group before it will be automatically created.

Miscellaneous Styles

MLink

An external link entry.

Modification Functions

NaturalDocs:: ClassHierarchy

NaturalDocs:: ClassHierarchy:: Class

NaturalDocs:: ClassHierarchy:: File

NaturalDocs:: Menu:: Entry

NaturalDocs:: SymbolTable

NaturalDocs:: SymbolTable:: File

NaturalDocs:: SymbolTable:: IndexElement

NaturalDocs:: SymbolTable:: Reference

NaturalDocs:: SymbolTable:: Symbol

NaturalDocs:: SymbolTable:: SymbolDefinition

MSubTitle

The subtitle of the menu.

MText

A plain text entry.

MTitle

The title of the menu.