NaturalDocs::NDMarkup

A package of support functions for dealing with NDMarkup.

Usage and Dependencies

The package doesn’t depend on any Natural Docs packages and is ready to use right away.

Summary
NaturalDocs::NDMarkupA package of support functions for dealing with NDMarkup.
Functions
ConvertAmpCharsSubstitutes certain characters with their NDMarkup amp chars.
RestoreAmpCharsReplaces NDMarkup amp chars with their original symbols.

Functions

ConvertAmpChars

sub ConvertAmpChars #(text)

Substitutes certain characters with their NDMarkup amp chars.

Parameters

textThe block of text to convert.

Returns

The converted text block.

RestoreAmpChars

sub RestoreAmpChars #(text)

Replaces NDMarkup amp chars with their original symbols.

Parameters

textThe text to restore.

Returns

The restored text.

A markup format used by the parser, both internally and in NaturalDocs::Parser::ParsedTopic objects.
sub ConvertAmpChars #(text)
Substitutes certain characters with their NDMarkup amp chars.
sub RestoreAmpChars #(text)
Replaces NDMarkup amp chars with their original symbols.