NaturalDocs::ImageReferenceTable::String

A package for creating and managing ImageReferenceStrings.

Summary
NaturalDocs::ImageReferenceTable::StringA package for creating and managing ImageReferenceStrings.
Types
ImageReferenceStringA string representing a unique image reference.
Functions
MakeConverts a source FileName and the reference text to an ImageReferenceString.
InformationOfReturns the information contained in the ImageReferenceString as the array ( path, text ).
ToBinaryFileWrites an ImageReferenceString to NaturalDocs::BinaryFile.
FromBinaryFileLoads an ImageReferenceString or undef from NaturalDocs::BinaryFile and returns it.

Types

ImageReferenceString

A string representing a unique image reference.  It’s composed of the reference text and the directory of the source file.  The source file name itself isn’t included because two files in the same directory with the same reference text will always go to the same targets.

Functions

Make

sub Make #(FileName sourceFile,
string text) => ImageReferenceString

Converts a source FileName and the reference text to an ImageReferenceString.

InformationOf

sub InformationOf #(ImageReferenceString referenceString)

Returns the information contained in the ImageReferenceString as the array ( path, text ).

ToBinaryFile

sub ToBinaryFile #(ImageReferenceString referenceString)

Writes an ImageReferenceString to NaturalDocs::BinaryFile.  Can also encode an undef.

Format

[UString16: path] [UString16: reference text] ...

Undef is represented by the first UString16 being undef.

FromBinaryFile

sub FromBinaryFile

Loads an ImageReferenceString or undef from NaturalDocs::BinaryFile and returns it.

A string representing a unique image reference.
sub Make #(FileName sourceFile,
string text) => ImageReferenceString
Converts a source FileName and the reference text to an ImageReferenceString.
A string representing the absolute, platform-dependent path to a file.
sub InformationOf #(ImageReferenceString referenceString)
Returns the information contained in the ImageReferenceString as the array ( path, text ).
sub ToBinaryFile #(ImageReferenceString referenceString)
Writes an ImageReferenceString to NaturalDocs::BinaryFile.
A package to manage Natural Docs’ binary data files.
sub FromBinaryFile
Loads an ImageReferenceString or undef from NaturalDocs::BinaryFile and returns it.