sub UnbuiltFilesWithContent

Returns an existence hashref of the FileNames that have Natural Docs content but are not part of FilesToBuild().

sub Unobscure #( text )

Restores text encoded with Obscure() and returns it.

sub UpdateFile #( sourceFile )

Updates an output file.

sub UpdateImage #( file )

Define this function to add or update the passed image in the output.

sub UpdateImage #( file )

Define this function to add or update the passed image in the output.

sub UpdateIndex #( type )

Updates an index’s output file.

sub UpdateMenu

Define this function to make the package update the menu.

sub UpdateMenu

Builds the menu file.

sub UpdateMenu

Updates the menu in all the output files that weren’t rebuilt.

sub UserConfigFile #( string  file )

Returns the full path to the passed user configuration file.

sub UserConfigFileStatus #( string  file )

Returns the FileStatus of the passed user configuration file.

sub Using

Returns an arrayref of SymbolStrings for using statements, or undef if none

sub Using

Returns an arrayref of additional scope SymbolStrings available to the topic via “using” statements, or undef if none.

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

sub WatchFileForChanges #( file )

Watches a file for changes, which can then be applied by AnalyzeChanges().

sub WatchFileForChanges #( FileName  filename )

Begins watching a file for changes.

sub WatchFileForChanges #( file )

Tracks a file to see if any symbols or references were changed or deleted in ways that would require other files to be rebuilt.

sub WatchingFileForChanges # => bool

Returns whether we’re currently watching a file for changes or not.

Returns the width in pixels, undef if it can’t be determined, and -1 if determination hasn’t been attempted yet.

sub WriteAString16 #( string  value )

Writes an AString16 to the open file.

sub WriteMenuEntries #( entries, fileHandle, indentChars, relativeFiles )

A recursive function to write the contents of an arrayref of NaturalDocs::Menu::Entry objects to disk.

sub WritePreviousMenuStateEntries #( entries, fileHandle )

A recursive function to write the contents of an arrayref of NaturalDocs::Menu::Entry objects to disk.

sub WriteUInt16 #( UInt16  value )

Writes a UInt32 to the open file.

sub WriteUInt32 #( UInt32  value )

Writes a UInt32 to the open file.

sub WriteUInt8 #( UInt8  value )

Writes a UInt8 to the open file.

sub XChomp #( lineRef )

A cross-platform chomp function.