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

J
	JavaScriptDirectory NaturalDocs::Builder::HTMLBase NaturalDocs::Settings
	Join, NaturalDocs::SymbolString
	JoinDirectories, NaturalDocs::File
	JoinPath, NaturalDocs::File
	JoinPaths, NaturalDocs::File
K
	keyTimeout, SearchPanel
	keyTimeoutLength, SearchPanel
	KeywordInfo, NaturalDocs::Topics
	keywords, NaturalDocs::Topics
	Konqueror
L
	language, NaturalDocs::Parser
	Language Notes
	Language Support NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl
	LanguageOf, NaturalDocs::Languages
	languages, NaturalDocs::Languages
NaturalDocs::	Languages
	Languages.txt
NaturalDocs::	Languages::ActionScript
NaturalDocs::	Languages::Ada
NaturalDocs::	Languages::Advanced
NaturalDocs::	Languages::Advanced::Scope
NaturalDocs::	Languages::Advanced::ScopeChange
NaturalDocs::	Languages::Base
NaturalDocs::	Languages::CSharp
NaturalDocs::	Languages::Pascal
NaturalDocs::	Languages::Perl
NaturalDocs::	Languages::PLSQL
NaturalDocs::	Languages::Prototype
NaturalDocs::	Languages::Prototype::Parameter
NaturalDocs::	Languages::Simple
NaturalDocs::	Languages::Tcl
	LAST_MODIFIED Modules\NaturalDocs\Project\ImageFile.pm Modules\NaturalDocs\Project\SourceFile.pm
	lastMatchCount, SearchResults
	lastMessageTime, NaturalDocs::StatusMessage
	LastModified NaturalDocs::Project::ImageFile NaturalDocs::Project::SourceFile
	lastResultsPage, SearchPanel
	lastSearchValue, SearchPanel
	legacyTypes, NaturalDocs::Topics
	License
	LINE_NUMBER Modules\NaturalDocs\Languages\Advanced\ScopeChange.pm Modules\NaturalDocs\Parser\ParsedTopic.pm
	LineCommentSymbols, NaturalDocs::Languages::Simple
	LineExtender, NaturalDocs::Languages::Simple
	lineNumber, NaturalDocs::ConfigFile
	LineNumber NaturalDocs::ConfigFile NaturalDocs::Languages::Advanced::ScopeChange NaturalDocs::Parser::ParsedTopic
	Link Structure
	Link Styles
	List Item Tags
	ListItems, NaturalDocs::SourceDB::File
	Load NaturalDocs::ClassHierarchy NaturalDocs::ImageReferenceTable NaturalDocs::Languages NaturalDocs::Settings NaturalDocs::SourceDB NaturalDocs::SourceDB::Extension NaturalDocs::SymbolTable NaturalDocs::Topics
	LoadAndComparePreviousSettings, NaturalDocs::Settings
	LoadAndUpdate, NaturalDocs::Menu
	LoadConfigFileInfo, NaturalDocs::Project
	LoadFile NaturalDocs::Languages NaturalDocs::Topics
	LoadImageFileInfo, NaturalDocs::Project
	LoadIndexInfo, NaturalDocs::SymbolTable
	LoadMenuFile, NaturalDocs::Menu
	LoadPreviousMenuStateFile, NaturalDocs::Menu
	LoadSourceFileInfo, NaturalDocs::Project
	LoadSymbolTable, NaturalDocs::SymbolTable
	LockUserTitleChanges, NaturalDocs::Menu
	Long code block scrolling
	longPrototypeDirectives, NaturalDocs::Languages::Pascal
	Lookup, NaturalDocs::SymbolTable
	Low Level Parsing Functions NaturalDocs::Languages::ActionScript NaturalDocs::Languages::CSharp NaturalDocs::Languages::Perl
	LType

sub JavaScriptDirectory

Returns the directory of the JavaScript files.

sub JavaScriptDirectory

Returns the main JavaScript directory.

sub Join #( string/SymbolString identifier/symbol,
string/SymolString identifier/symbol,
... )

Takes a list of identifiers and/or SymbolStrings and returns it as a new SymbolString.

sub JoinDirectories #( directory,
directory,
... )

Creates a directory string from an array of directory names.

sub JoinPath #( volume,
dirString,
$file )

Creates a path from its elements.

sub JoinPaths #( basePath,
extraPath,
noFileInExtra )

Joins two paths.

this.keyTimeout

The timeout used between a keystroke and when a search is performed.

this.keyTimeoutLength

The length of keyTimeout in thousandths of a second.

sub KeywordInfo #( keyword )

Returns information about a topic keyword.

my %keywords

A hashref that maps all-lowercase keywords to their TopicTypes.

Konqueror and anything else based on the KHTML rendering engine except Safari.

my $language

The language object for the file, derived from NaturalDocs::Languages::Base.

This is more for my personal reference than anything else.

sub LanguageOf #( sourceFile )

Returns the language of the passed source file.

my %languages

A hash of all the defined languages.

A package to manage all the programming languages Natural Docs supports.

The configuration file that defines or overrides the language definitions for Natural Docs.

A subclass to handle the language variations of Flash ActionScript.

A subclass to handle the language variations of Ada

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 C#.

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 PL/SQL.

A data class for storing parsed prototypes.

A data class for storing parsed prototype parameters.

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.

The integer timestamp of when the file was last modified.

this.lastMatchCount

The number of matches from the last run of Search().

my $lastMessageTime

The time the last message was posted.

Returns the integer timestamp of when the file was last modified.

sub LastModified

Returns the integer timestamp of when the file was last modified.

this.lastResultsPage

The last results page.

this.lastSearchValue

The last search string executed, or an empty string if none.

my @legacyTypes

An array that converts the legacy topic types, which were numeric constants prior to 1.3, to the current TopicTypes.

Licensed under the GNU General Public License

The line number of the change.

Returns an arrayref of symbols that start a line comment, or undef if none.

Returns the symbol to ignore a line break in languages where line breaks are significant.

my $lineNumber

The current line number for the configuration file.

sub LineNumber

Returns the line number for the line last returned by GetLine().

sub LineNumber

Returns the line number of the change.

sub LineNumber

Returns the line the topic appears at in the file.

All links to symbols have a type style prefixed with L.

These tags will only appear within their respective lists.

sub ListItems #( ExtensionID extension ) => string array

Returns an array of all the item strings defined for a particular extension, or an empty list if none.

sub Load

Loads the class hierarchy from disk.

sub Load # => bool

Loads the data from ImageReferenceTable.nd.

sub Load

Loads both the master and the project version of Languages.txt.

sub Load

Loads and parses all settings from the command line and configuration files.

sub Load

Loads the data of the source database and all the extensions.

sub Load # => bool

Called by NaturalDocs::SourceDB->Load() to load the extension’s data.

sub Load

Loads all data files from disk.

sub Load

Loads both the master and the project version of Topics.txt.

sub LoadAndComparePreviousSettings

Loads PreviousSettings.nd and compares the values there with those in the command line.

sub LoadAndUpdate

Loads the menu file from disk and updates it.

sub LoadConfigFileInfo

Loads the config file info from disk.

sub LoadFile #( isMain,
tempExtensions,
tempShebangStrings )

Loads a particular version of Languages.txt.

sub LoadFile #( isMain )

Loads a particular version of Topics.txt.

sub LoadImageFileInfo

Loads the image file info from disk.

sub LoadIndexInfo

Loads IndexInfo.nd from disk.

sub LoadMenuFile

Loads and parses the menu file Menu.txt.

sub LoadPreviousMenuStateFile

Loads and parses the previous menu state file.

sub LoadSourceFileInfo

Loads the project file from disk and compares it against the files in the input directory.

sub LoadSymbolTable

Loads SymbolTable.nd from disk.

sub LockUserTitleChanges #( previousMenuFiles )

Detects if the user manually changed any file titles, and if so, automatically locks them with MENU_FILE_NOAUTOTITLE.

Go to Prototype Parameter Styles.

my %longPrototypeDirectives

An existence hash of all the directives with parameters that can appear after a function prototype and will be included.

sub Lookup #( symbol,
file )

Returns information on the passed SymbolString, if it exists.

A placeholder for all topic-specific styles.