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
 MADE_EMPTY_SEARCH_RESULTS_PAGE
 MadeEmptySearchResultsPage, NaturalDocs::Builder::HTMLBase
 mainConfigFile, NaturalDocs::Project
 MainConfigFile, NaturalDocs::Project
 MainConfigFileStatus, NaturalDocs::Project
 MainCSSFile, NaturalDocs::Builder::HTMLBase
 MainJavaScriptFile, NaturalDocs::Builder::HTMLBase
 mainLanguageNames, NaturalDocs::Languages
 mainTopicNames, NaturalDocs::Topics
 Make, NaturalDocs::ImageReferenceTable::String
 MakeAutoGroups, NaturalDocs::Parser
 MakeAutoGroupsFor, NaturalDocs::Parser
 MakeEMailLink, NaturalDocs::Parser::JavaDoc
 MakeFrom, NaturalDocs::ReferenceString
 MakeIndex, NaturalDocs::SymbolTable
 MakeParsedTopic, NaturalDocs::Parser::Native
 MakeRelativePath, NaturalDocs::File
 MakeRelativeURL, NaturalDocs::Builder::HTMLBase
 MakeSortableSymbol, NaturalDocs::SymbolTable::IndexElement
 MakeTopicType, NaturalDocs::Topics
 MakeURLLink, NaturalDocs::Parser::JavaDoc
 MarkEndOfOriginal, NaturalDocs::Menu::Entry
 MatchDirectoriesAndGroups, NaturalDocs::Menu
 MAXFILESINGROUP
 memberModifiers, NaturalDocs::Languages::ActionScript
 Members
 menu, NaturalDocs::Menu
NaturalDocs::Menu
 Menu and Class Hierarchies
 Menu Entry Flags
 Menu Length Constants
 Menu Package Variables, NaturalDocs::Builder::HTMLBase
 Menu Structure
 Menu Styles
 Menu.txt
NaturalDocs::Menu::Entry
 MENU_DATA
 MENU_ENDOFORIGINAL
 MENU_FILE
 MENU_FILE_LENGTH
 MENU_FILE_NOAUTOTITLE
 MENU_FOOTER
 MENU_FORMAT
 MENU_GROUP
 MENU_GROUP_EVERYTHINGSORTED
 MENU_GROUP_FILESANDGROUPSSORTED
 MENU_GROUP_FILESSORTED
 MENU_GROUP_HASENDOFORIGINAL
 MENU_GROUP_ISINDEXGROUP
 MENU_GROUP_LENGTH
 MENU_GROUP_UNSORTED
 MENU_GROUP_UPDATEORDER
 MENU_GROUP_UPDATESTRUCTURE
 MENU_GROUP_UPDATETITLES
 MENU_INDEX
 MENU_LENGTH_LIMIT
 MENU_LINK
 MENU_LINK_LENGTH
 MENU_SUBTITLE
 MENU_SUBTITLE_LENGTH
 MENU_TEXT
 MENU_TEXT_LENGTH
 MENU_TITLE
 MENU_TITLE_LENGTH
 MenuEntryType
 menuGroupLengths, NaturalDocs::Builder::HTMLBase
 menuGroupNumber, NaturalDocs::Builder::HTMLBase
 menuGroupNumbers, NaturalDocs::Builder::HTMLBase
 menuLength, NaturalDocs::Builder::HTMLBase
 menuNumbersAndLengthsDone, NaturalDocs::Builder::HTMLBase
 menuRootLength, NaturalDocs::Builder::HTMLBase
 Merge, NaturalDocs::SymbolTable::IndexElement
 MergeAutoTopics, NaturalDocs::Parser
 MergeFile, NaturalDocs::SymbolTable::IndexElement
 Merging Auto Topics
 message, NaturalDocs::StatusMessage
 MFile
 MGroup
 MGroupContent
 MigrateOldFiles, NaturalDocs::Project
 MIndex
 MINFILESINNEWGROUP
 Misc Functions, NaturalDocs::ConfigFile
 Miscellaneous Styles
 MLink
 mode
 Modification Functions
 mostUsedLanguage, NaturalDocs::Project
 MostUsedLanguage, NaturalDocs::Project
 MSearchPanelActive
 MSearchPanelInactive
 MSubTitle
 MText
 MTitle
 MType
Whether the search results page for searches with no results was generated.
Returns whether the empty search results page was created or not.
my %mainConfigFiles
A hash mapping all the main configuration file names without paths to their FileStatus.
sub MainConfigFile #(string file)
Returns the full path to the passed main configuration file.
sub MainConfigFileStatus #(string file)
Returns the FileStatus of the passed main configuration file.
sub MainCSSFile
Returns the location of the main CSS file.
sub MainJavaScriptFile
Returns the location of the main JavaScript file.
my @mainLanguageNames
An array of the language names that are defined in the main Languages.txt.
my @mainTopicNames
An array of the TopicType names that are defined in the main Topics.txt.
sub Make #(FileName sourceFile,
string text) => ImageReferenceString
Converts a source FileName and the reference text to an ImageReferenceString.
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.
sub MakeEMailLink #(target,
text)
sub MakeFrom #(ReferenceType type,
SymbolString symbol,
string language,
SymbolString scope,
SymbolString[] *using,
flags resolvingFlags)
Encodes the passed information as a ReferenceString.
sub MakeIndex #(type)
Generates a symbol index.
sub MakeParsedTopic #(type,
title,
package,
body,
lineNumber,
isList)
Creates a NaturalDocs::Parser::ParsedTopic object for the passed parameters.
sub MakeRelativePath #(basePath,
targetPath)
Takes two paths and returns a relative path between them.
sub MakeRelativeURL #(FileName baseFile,
FileName targetFile,
bool baseHasFileName) -> string relativeURL
Returns a relative path between two files in the output tree and returns it in URL format.
sub MakeSortableSymbol
Generates SortableSymbol() and IgnoredPrefix().
sub MakeTopicType #(topicName)
Returns a TopicType for the passed topic name.
sub MakeURLLink #(target,
text)
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.
sub MatchDirectoriesAndGroups
Determines which groups files in certain directories should be placed in.
The maximum number of file entries that can be present in a group before it becomes a candidate for sub-grouping.
my %memberModifiers
An existence hash of all the acceptable class member modifiers.
The object is implemented as a blessed arrayref, with the follow constants as indexes.
The following constants are indexes into the object array.
These constants serve as indexes into the object array.
The following constants are indexes into the object array.
This object would only have one member, which is an array, so the object itself serves as that member.
my $menu
The parsed menu file.
A package handling the menu’s contents and state.
Go to NaturalDocs::Languages::Simple.
The various flags that can apply to a menu entry.
Constants used to approximate the lengths of the menu or its groups.
These variables are for the menu generation functions only.
Everything is enclosed in a #Menu.
The file used to generate the menu.
A class representing an entry in the menu.
Data not meant for user editing.
A dummy entry that marks where the original group content ends.
A source file, relative to the source directory.
The length of one file entry.
Whether the file is auto-titled or not.
Footer text.
The version of Natural Docs the menu file was generated with.
A group.
All entries in the group are sorted alphabetically.
The group’s files and sub-groups are sorted alphabetically.
The group’s files are sorted alphabetically.
Whether the group contains a dummy MENU_ENDOFORIGINAL entry.
Whether the group is used primarily for MENU_INDEX entries.
The length of one group entry.
The group’s contents are not sorted.
The group should be resorted.
The group should be checked for structural changes, such as being removed or being split into subgroups.
The group should have its auto-titles regenerated.
An index.
The limit of the menu’s length.
A web link.
The length of one link entry.
The sub-title of the menu.
The length of the subtitle.
Arbitrary text.
The length of one text entry.
The title of the menu.
The length of the title.
The types of entries that can appear in the menu.
my %menuGroupLengths
A hash of the length of each group, not including any subgroup contents.
my $menuGroupNumber
The current menu group number.
my %menuGroupNumbers
A hash of the number of each group, as managed by menuGroupNumber.
my $menuLength
The length of the entire menu, fully expanded.
my $menuNumbersAndLengthsDone
Set when the variables that only need to be calculated for the menu once are done.
my $menuRootLength
The length of the top-level menu entries without expansion.
sub Merge #(package,
file,
type,
prototype,
summary)
Adds another definition of the same symbol.
sub MergeAutoTopics #(language,
autoTopics)
Merges the automatically generated topics into the file.
sub MergeFile #(file,
type,
prototype,
summary)
Adds another definition of the same package/symbol.
As mentioned above, ParseFile() also returns a set of ParsedTopics gleaned from the code called autotopics.
my $message
The message to display.
A file entry.
A group entry.
A container for a MGroup’s content.
sub MigrateOldFiles
If the project uses the old file names used prior to 1.14, it converts them to the new file names.
An index entry.
The minimum number of file entries that must be present in a group before it will be automatically created.
An external link entry.
this.mode
The mode the search is going to work in, such as “HTML” or “FramedHTML”.
this.mode
The mode the search is going to work in, such as “HTML” or “FramedHTML”.
These functions should not be called after PurgeResolvingInfo().
my $mostUsedLanguage
The name of the most used language.
sub MostUsedLanguage
Returns the name of the most used language in the source trees.
Applied to #MSearchPanel when any of the controls are selected or the results window is open.
Applied to #MSearchPanel when not in use.
The subtitle of the menu.
A plain text entry.
The title of the menu.
MFile, MGroup, MText, MLink, or MIndex.
Close