Aargh

The Text Element

The Text element encloses literal text to be inserted into the comment block at the head of a generated source file. Typically this text might identify the application for which the source file was generated, or provide other background information. For example:
		<Text which="header">
 This class represents the command
 line for the AnagramGen application.
		</Text>

Attributes

Like other elements within the Remarks aggregate, the Text element may carry a which attribute indicating whether the enclosed text should be inserted into the header file, the implementation file, or both. The valid values are "header", "implementation", and "both", with the obvious meanings.

If no which attribute is supplied, aargh will insert the enclosed text into both generated files.

Enclosed Elements

The Text element may enclose only literal text and XML comments. Aargh will of course eliminate the XML comments. It will also skip over a single leading newline, if one is present, so that you can start the text on a new line within the XML without introducing an unwanted blank line in the output. In other respects aargh will preserve the text intact, including all white space.


Home