A package for creating and managing ImageReferenceStrings.
NaturalDocs:: | A package for creating and managing ImageReferenceStrings. |
Types | |
ImageReferenceString | A string representing a unique image reference. |
Functions | |
Make | Converts a source FileName and the reference text to an ImageReferenceString. |
InformationOf | Returns the information contained in the ImageReferenceString as the array ( path, text ). |
ToBinaryFile | Writes an ImageReferenceString to NaturalDocs::BinaryFile. |
FromBinaryFile | Loads an ImageReferenceString or undef from NaturalDocs::BinaryFile and returns it. |
sub Make #( FileName sourceFile, string text ) => ImageReferenceString
Converts a source FileName and the reference text to an ImageReferenceString.
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. Can also encode an undef.
[UString16: path] [UString16: reference text] ...
Undef is represented by the first UString16 being undef.
sub FromBinaryFile
Loads an ImageReferenceString or undef from NaturalDocs::BinaryFile and returns it.
Converts a source FileName and the reference text to an ImageReferenceString.
sub Make #( FileName sourceFile, string text ) => ImageReferenceString
Returns the information contained in the ImageReferenceString as the array ( path, text ).
sub InformationOf #( ImageReferenceString referenceString )
Writes an ImageReferenceString to NaturalDocs::BinaryFile.
sub ToBinaryFile #( ImageReferenceString referenceString )
Loads an ImageReferenceString or undef from NaturalDocs::BinaryFile and returns it.
sub FromBinaryFile