sub Obscure #( text )

Obscures the passed text so that it is not user editable and returns it.

sub OnChangedDefinition #( string  itemString, FileName  file )

Called for each definition changed by NaturalDocs::SourceDB.

sub OnClass #( class )

A function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a class declaration.

sub OnClassParent #( class, parent, scope, using, resolvingFlags )

A function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a declaration of inheritance.

sub OnCode #( ... )

Just overridden to reset checkingForDirectives.

sub OnCode #( codeLines, codeLineNumber, topicList, lastCommentTopicCount )

Called whenever a section of code is encountered by the parser.

sub OnCode #( ... )

This is just overridden to reset pastFirstBrace.

sub OnComment #( string[]  commentLines, int  lineNumber, bool  isJavaDoc )

The function called by NaturalDocs::Languages::Base-derived objects when their parsers encounter a comment suitable for documentation.

sub OnDefaultTitleChange #( file )

Called by NaturalDocs::Project if the default menu title of a source file has changed.

sub OnDeletedDefinition #( ImageReferenceString  referenceString, FileName  file, bool  wasLastDefinition )

Called for each definition deleted by NaturalDocs::SourceDB.

sub OnDeletedDefinition #( string  itemString, FileName  file, bool  wasLastDefinition )

Called for each definition deleted by NaturalDocs::SourceDB.

sub OnEndBuilding #( FileName  file )

Called whenever NaturalDocs::Builder is done building a source file.

sub OnEndParsing #( FileName  file )

Called whenever NaturalDocs::Parser is done parsing a source file.

sub OnIndexChange #( TopicType  type )

Called whenever a change happens to a symbol that would cause an index to be regenerated.

sub OnInterpretationChange #( reference )

Called by NaturalDocs::SymbolTable whenever a class hierarchy reference’s intepretation changes, meaning it switched from one symbol to another.

sub OnInterpretationChange #( referenceString )

Called whenever the current interpretation of a reference changes, meaning it switched from one symbol to another.

sub OnlyBeforeParameters

Returns whether BeforeParameters() is the only thing set.

sub OnlyFileTitles

Returns whether source files should always use the file name as the title.

sub OnMostUsedLanguageKnown

Called when the most used language is known.

sub OnPrototypeEnd #( type, prototypeRef, ender )

Pascal’s syntax has directives after the prototype that should be included.

sub OnPrototypeEnd #( type, prototypeRef, ender )

Microsoft’s SQL specifies parameters as shown below.

sub OnPrototypeEnd #( type, prototypeRef, ender )

Called whenever the end of a prototype is found so that there’s a chance for derived classes to mark false positives.

sub OnPrototypeEnd #( type, prototypeRef, ender )

Tcl’s function syntax is shown below.

this.OnSearchFieldChange = function()

Called when the content of the search field is changed.

this.OnSearchFieldFocus = function( isActive )

Called when focus is added or removed from the search field.

this.OnSearchTypeChange = function()

Called when the search type is changed.

this.OnSearchTypeFocus = function( isActive )

Called when focus is added or removed from the search type.

sub OnStartBuilding #( FileName  file )

Called whenever NaturalDocs::Builder starts building a source file.

sub OnStartParsing #( FileName  file )

Called whenever NaturalDocs::Parser starts parsing a source file.

sub OnTargetSymbolChange #( reference )

Called by NaturalDocs::SymbolTable whenever a class hierarchy reference’s target symbol changes, but the reference still resolves to the same symbol.

sub OnTargetSymbolChange #( referenceString )

Called whenever the symbol that serves as the interpretation of a reference changes, but the reference still resolves to the same symbol.

sub Open #( file, hasBraceGroups )

Opens a configuration file for parsing and returns the format VersionInt.

sub OpenForReading #( FileName  file, optional  VersionInt  minimumVersion ) => VersionInt

Opens a binary file for reading.

sub OpenForWriting #( FileName  file )

Opens a binary file for writing and writes the standard header.

sub OpeningBrowserStyles

Returns the JavaScript that will add opening browser styles if necessary.

sub OutputDirectoryOf #( object )

Returns the output directory of a builder object.

sub OutputFileOf #( sourceFile )

Returns the output file name of the source file.

sub OutputImageOf #( sourceImageFile )

Returns the output image file name of the source image file.

sub OutputPackageOf #( commandLineOption )

Returns the output package corresponding to the passed command line option, or undef if none.

sub OutputPackages

Returns an arrayref of the output packages available for use.