sub Index #(type)

Returns a symbol index.

sub IndexChanged #(type)

Returns whether the specified index has changed.

sub Indexes

Returns an existence hashref of all the indexes appearing in the menu.

Returns the output file name of the index file.

Define this function to call NaturalDocs::Builder->Add() so that NaturalDocs::Builder knows about this package.

sub INIT

Registers the package with NaturalDocs::Builder.

sub INIT

Registers the package with NaturalDocs::Builder.

For any extension package to be recognized, it must define INIT and have it call NaturalDocs::Extensions->Add() for itself.

sub InputDirectories

Returns an arrayref of input directories.

sub InputDirectoryNameOf #(directory)

Returns the generated name of the passed input directory.

sub Interpretations

Returns an array of all the symbol strings that this reference can be interpreted as.

sub InterpretationsAndScores

Returns a hash of all the symbol strings that this reference can be interpreted as and their scores.

sub InterpretReference #(referenceString)

Interprets the passed reference, matching it to the defined symbol with the highest score.

sub IsAtSequence # ( index, token, token, token ... )

Returns whether the position is at a sequence of tokens.

sub IsBackslashed #(index)

Returns whether the position is after a backslash.

sub IsDefined

Returns whether the class is defined in any files.

sub IsDefined

Returns whether the reference has any definitions or not.

sub IsDefined

Returns whether the symbol is defined anywhere or not.

sub IsDefinedIn #(file)

Returns whether the class is defined in the passed file.

sub IsDefinedIn #(file)

Returns whether the reference is defined in the passed file.

sub IsDefinedIn #(file)

Returns whether the symbol is defined in the passed file.

sub IsFirstLineToken #(index)

Returns whether the position is at the first token of a line, not including whitespace.

sub IsIndexable #(topic)

Returns whether the topic should be indexed.

sub IsLastLineToken #(index)

Returns whether the position is at the last token of a line, not including whitespace.

sub IsList #(topic)

Returns whether the topic is a list topic.

sub IsListOf #(topic)

Returns what type the list topic is a list of.

sub IsQuiet

Returns whether the script should be run in quiet mode or not.

sub IsStringed #(index)

Returns whether the position is after a string (dollar sign) character.

sub IsSubPathOf # ( base, path )

Returns whether the path is a descendant of another path.

sub IsSupported #(file)

Returns whether the language of the passed file is supported.

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.

sub LanguageOf #(sourceFile)

Returns the language of the passed source file.

sub LastModified

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

sub LineCommentSymbols

Returns an arrayref of symbols used to start a single line comment, or undef if none.

sub LineExtender

Returns the symbol used to extend a line of code past a line break, or undef if not applicable.

sub LineNumber

Returns the line number of the change.

sub LineNumber

Returns the line the topic appears at in the file.

sub Load

Loads the class hierarchy from disk.

sub Load

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

sub Load

Loads the symbol table from disk.

sub LoadAndComparePreviousSettings

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

sub LoadAndDetectChanges

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

sub LoadAndUpdate

Loads the menu file from disk and updates it.

sub LoadMenuFile

Loads and parses the menu file Menu.txt.

sub LoadPreviousMenuStateFile

Loads and parses the previous menu state file.

sub LoadSettingsFile

Loads and parses Settings.txt.

sub LockUserTitleChanges #(previousMenuFiles)

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