sub Save

Saves the class hierarchy to disk.

sub Save

Writes the changes to the menu files.

sub Save

Saves the project file to disk.

sub Save

Saves all settings in configuration files to disk.

sub Save

Saves the symbol table to disk.

sub SaveMenuFile

Saves the current menu to Menu.txt.

sub SavePreviousMenuStateFile

Saves changes to PreviousMenuState.nd.

sub SavePreviousSettings

Saves the settings into PreviousSettings.nd.

sub SaveSettingsFile

Saves Settings.txt to disk.

sub Scope

Returns what the scope was changed to.

sub Scope

Returns the scope the topic appears in.

sub ScopeRecord

Returns an arrayref of NaturalDocs::Languages::Advanced::ScopeChange objects describing how and when the scope changed thoughout the file.

sub ScopeSymbol

Returns the symbol that ends the current scope level, or undef if we are at the top level.

sub SeparateMember #(string)

Separates a class from its member.

sub SetBody #(body)

Replaces the topic’s body, formatted in NDMarkup.

sub SetClass #(class)

Replaces the topic’s class.

sub SetCurrentInterpretation #(symbolString)

Changes the current interpretation.

sub SetDefaultMenuTitle # ( file, menuTitle )

Sets the file’s default menu title.

sub SetDefaultMenuTitle #(menuTitle)

Sets the file’s default title on the menu.

sub SetFlags #(flags)

Replaces the Menu Entry Flags.

sub SetHasContent # ( file, hasContent )

Sets whether the file has Natural Docs content or not.

sub SetHasContent #(hasContent)

Sets whether the file contains Natural Docs content or not.

sub SetLastModified #(lastModified)

Sets the file’s last modification timestamp.

sub SetName #(name)

Changes the target’s name.

sub SetNamespace # ( namespace, lineNumber )

Sets the namespace for the current scope level.

sub SetNamespace #(namespace)

Sets the namespace of the scope.

sub SetPackage # ( package, lineNumber )

Sets the package or class for the current scope level.

sub SetPackage #(package)

Sets the package or class of the scope.

sub SetProtection # ( protection, lineNumber )

Sets the protection for the current scope level.

sub SetProtection #(protection)

Sets the protection of the scope.

sub SetPrototype #(prototype)

Replaces the function or variable prototype.

sub SetPrototype #(prototype)

Changes the prototype.

sub SetScope #(scope)

Replaces what the scope was changed to.

sub SetScope #(scope)

Replaces the topic’s scope.

sub SetStatus #(status)

Sets the file’s status since the last build.

sub SetSummary #(summary)

Changes the summary.

sub SetTarget #(target)

Replaces the entry’s target.

sub SettingsFile

Returns the full path to the project’s settings file.

sub SetTitle #(title)

Replaces the entry’s title.

sub SetTokens #(tokens)

Replaces the tokens.

sub SetType #(type)

Changes the type.

Returns an array of all the directories shared by the files in the group.

sub ShebangStrings

Returns all the possible strings that can appear in a shebang line (#!)

sub ShebangStrings

Returns an arrayref of the strings that can appear in the language’s shebang string.

sub ShebangStrings

Returns all the possible strings that can appear in a shebang line (#!)

sub ShortenToMatchStrings # ( sharedArrayRef, compareArrayRef )

Compares two arrayrefs and shortens the first array to only contain shared entries.

sub SkipRestOfLine # ( indexRef, lineNumberRef )

Moves the position to the token following the next line break, or past the end of the tokens array if there is none.

sub SkipRestOfStatement # ( indexRef, lineNumberRef )

Advances the position via GenericSkip() until after the end of the current statement, which is defined as a semicolon or a brace group.

sub SkipUntilAfter # ( indexRef, lineNumberRef, token, token, token ... )

Moves the position to the token following the next occurance of a particular token sequence, or past the end of the tokens array if it never occurs.

sub Sort

Sorts the class and file lists of the symbol.

sub SplitDirectories #(directoryString)

Takes a string of directories and returns an array of its elements.

sub SplitFromInputDirectory #(file)

Takes an input file name and returns the array ( inputDirectory, relativePath ).

sub SplitPath # ( path, noFile )

Takes a path and returns its elements.

sub Start

This will be called whenever a file is about to be parsed.

sub StartingParseOf #(file)

Notifies the package that a new configuration file is about to be parsed.

sub StartScope # ( symbol, lineNumber, namespace, package, protection )

Records a new scope level.

sub Status

Returns the status of the file since the last build.

sub StatusOf #(file)

Returns the status of the passed file.

sub StringCompare # ( a, b )

Compares two strings so that the result is good for proper sorting.

Converts a text string to HTML.

sub StripClosingSymbol # ( lineRef, symbols )

Determines if the line contains a symbol, and if so, truncates it just before the symbol.

sub StripOpeningSymbol # ( lineRef, symbols )

Determines if the line starts with any of the passed symbols, and if so, replaces it with spaces.

sub Style

Returns the target’s style, CSS if it’s HTML based.

sub StyleDirectory

Returns the main style directory.

sub SubTitle

Returns the sub-title of the menu, or undef if none.

sub Summary

Returns the topic summary, if it exists, formatted in NDMarkup.

sub Summary

Returns the summary of the class/symbol/file, if applicable.

sub Summary

Returns the target’s summary, or undef if not defined or not applicable.

sub Summary

Returns the definition’s summary, or undef if it doesn’t have one.

sub SummaryDefinedIn #(file)

Returns the summary of symbol defined in the passed file, or undef if it doesn’t exist or is not defined in that file.

sub Symbol

Returns the closing symbol of the scope.

sub Symbol

Returns the symbol name if applicable.

sub Symbol

Returns the target’s symbol.

sub Symbols

Returns an array of all the symbols defined in this file.

sub SymbolTableFile

Returns the full path to the symbol table’s data file.

Converts a class and symbol to a HTML symbol, meaning one that is safe to include in anchor and link tags.