Natural Docs
Version 1.2
Natural Docs
Packages
Objects
Languages
Output Formats
Extensions
Documentation
Indexes
Web Site

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:: NDMarkup
A package of support functions for dealing with NDMarkup.
ConvertAmpChars
Substitutes certain characters with their NDMarkup amp chars.
RestoreAmpChars
Replaces NDMarkup amp chars with their original symbols.

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.
Copyright © 2003-2004 Greg Valure.  Generated by Natural Docs.
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.