sub Save

Saves the class hierarchy to disk.

sub Save

Saves the data to ImageReferenceTable.nd.

sub Save

Saves the main and user versions of Languages.txt.

sub Save

Writes the changes to the menu files.

sub Save

Saves all settings in configuration files to disk.

sub Save

Saves the data of the source database and all its extensions.

sub Save

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

sub Save

Saves all data files to disk.

sub Save

Saves the main and user versions of Topics.txt.

sub SaveConfigFileInfo

Saves the config file info to disk.

sub SaveFile #( isMain )

Saves a particular version of Topics.txt.

sub SaveFile #( isMain )

Saves a particular version of Topics.txt.

sub SaveImageFileInfo

Saves the image file info to disk.

sub SaveIndexInfo

Saves IndexInfo.nd 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 SaveSourceFileInfo

Saves the source file info to disk.

sub SaveSymbolTable

Saves SymbolTable.nd to disk.

sub Scope

Returns the SymbolString the scope was changed to.

Returns the topic’s ScopeType.

sub ScopeRecord

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

this.Search = function()

Performs a search.

this.Search = function( search )

Searches for the passed string.

sub SearchDataJavaScriptFile

Returns the location of the search data JavaScript file.

sub SearchResultsDirectory

Returns the directory of the search results files.

sub SearchResultsFileOf #( TopicType  type, string  extra )

Returns the output file name of the search result file.

Replaces the part of the prototype after the parameter list.

Replaces the part of the prototype before the parameter list.

Replaces the arrayref of start/end symbol pairs that specify a block comment.

sub SetBody #( body )

Replaces the topic’s body, formatted in NDMarkup.

Sets whether list topics should be broken into individual topics in the output.

Replaces the NaturalDocs::Builder::Base-derived object for the target’s output format.

sub SetCanGroupWith #( TopicType[]  types )

Sets the list of TopicTypes the type can be grouped with.

Sets whether the topic is part of the class hierarchy.

sub SetCurrentInterpretation #( symbol )

Changes the current interpretation.

sub SetDefaultMenuTitle #( file, menuTitle )

Sets the FileName’s default menu title.

sub SetDefaultMenuTitle #( menuTitle )

Sets the file’s default title on the menu.

Replaces the default value expression.

Replaces the default value prefix.

sub SetDimensions #( int  width, int  height )

Sets the width and height of the image.

Replaces the directory for the target’s output files.

Replaces the EnumValuesType that describes how the language handles enums.

Replaces the arrayref of the language’s file extensions.

sub SetFlags #( flags )

Replaces the Menu Entry Flags.

sub SetHasContent #( file, hasContent )

Sets whether the FileName has Natural Docs content or not.

sub SetHasContent #( hasContent )

Sets whether the file contains Natural Docs content or not.

sub SetIgnoredPrefixesFor #( type, prefixes )

Replaces the arrayref of ignored prefixes for the passed TopicType.

Sets whether the topic is indexed.

sub SetIsList

Sets whether the topic is a list.

Sets the file’s last modification timestamp.

sub SetLastModified #( lastModified )

Sets the file’s last modification timestamp.

Replaces the arrayref of symbols that start a line comment.

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

Sets whether the empty search results page was created or not.

Replaces the parameter name.

Replaces the parameter name prefix.

sub SetPackage #( package, lineNumber )

Sets the package for the current scope level.

sub SetPackage #( package )

Sets the package SymbolString of the scope.

sub SetPackage #( package )

Replaces the package the topic appears in.

Replaces the language’s package separator string.

Sets whether the topic becomes the page title if it’s first in the file.

Replaces the topic’s plural name.

sub SetPrototype #( prototype )

Replaces the function or variable prototype.

sub SetPrototype #( prototype )

Changes the prototype.

sub SetPrototypeEndersFor #( type, enders )

Replaces the arrayref of prototype ender symbols for the passed TopicType.

sub SetReferenceTarget #( ImageReferenceString  referenceString ) => FileName

Determines the best target for the passed ImageReferenceString and sets it on the NaturalDocs::ImageReferenceTable::Reference object.

sub SetScope #( scope )

Replaces the SymbolString the scope was changed to.

Replaces the topic’s ScopeType.

Replaces the arrayref of the language’s shebang strings.

Sets the FileStatus since the last build.

sub SetStatus #( status )

Sets the FileStatus since the last build.

sub SetSummary #( summary )

Changes the summary.

Replaces the image FileName this reference resolves to, or undef if none.

sub SetTarget #( target )

Replaces the entry’s target.

sub SetTitle #( title )

Replaces the entry’s title.

sub SetTitle #( title )

Replaces the topic title.

sub SetTokens #( tokens )

Replaces the tokens.

Replaces the parameter type.

sub SetType #( type )

Replaces the TopicType.

sub SetType #( type )

Changes the TopicType.

Replaces the parameter type prefix.

sub SetUsing #( using )

Replaces the using arrayref of sope SymbolStrings.

Sets whether this image file was used during the last Natural Docs execution.

sub SharedDirectoriesOf #( group )

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

Returns an arrayref of the language’s shebang strings, or undef if none.

sub ShortenToMatchStrings #( sharedArrayRef, compareArrayRef )

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

sub SingularInterpretationsOf #( symbol )

Generates singular interpretations of a SymbolString if it can be interpreted as a plural.

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 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 SkipToNextStatement #( indexRef, lineNumberRef )

Advances the position via GenericSkip() until the next statement, which is defined as anything in declarationEnders not appearing in brackets or strings.

sub SkipToNextXMLTag #( indexRef, lineNumberRef )

Skips to the next normal XML tag.

sub SkipUntilAfter #( indexRef, lineNumberRef, 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 SoftDeath #( message )

Generates a “soft” death, which means the program exits like with Perl’s die(), but no crash report will be generated.

sub Sort

Sorts the package and file lists of the symbol.

Returns the sortable symbol as a text string.

sub SplitDirectories #( directoryString )

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

sub SplitFromImageDirectory #( file )

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

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 SplitSymbolForIndex #( symbol, type )

Splits a SymbolString into its symbol and package portions for indexing.

sub StandardComments

Returns the standard HTML comments that should be included in every generated file.

sub Start

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

sub Start #( message, total )

Starts the status message.

sub StartScope #( closingSymbol, lineNumber, package )

Records a new scope level.

Returns the FileStatus since the last build.

sub Status

Returns the FileStatus since the last build.

sub StatusOf #( file )

Returns the FileStatus of the passed FileName.

sub StringCompare #( a, b )

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

sub StringToHTML #( string, addHiddenBreaks )

Converts a text string to HTML.

sub StringToSearchResultID #( string  string,    bool  dontIncrement  =  0 ) => string

Takes a text string and translates it into something that can be used as a CSS ID.

sub StripClosingSymbol #( lineRef, symbol )

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

sub StripOpeningBlockSymbols #( lineRef, symbolPairs )

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

sub StripOpeningJavaDocBlockSymbols #( lineRef, symbolPairs )

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

sub StripOpeningJavaDocSymbols #( lineRef, symbols )

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

sub StripOpeningSymbols #( lineRef, symbols )

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

sub StyleDirectory

Returns the main style directory.

sub Styles

Returns an arrayref of the styles associated with the output.

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.

Returns the summary of the package/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 FileName, or undef if it doesn’t exist or is not defined in that file.

sub Symbol

Returns the SymbolString defined by the topic.

Returns the SymbolString without the package portion.

sub Symbol

Returns the target’s SymbolString.

sub Symbols

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

sub SymbolToHTMLSymbol #( symbol )

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