Aargh
The Remarks Aggregate
The Remarks element encloses a series of zero or more elements, and
has no attributes of its own.
Each element defines a fragment of text to be inserted into a
C-style comment block (delimited by "/*" and "*/") at the top of
the generated source files. It may carry a which
attribute with any of three possible values:
- "header" -- include the text in the header file
- "implementation" -- include the text in the implementation file
- "both" -- include the text in both generated files
If no which attribute is specified, aargh inserts the
specified text into both files.
Aargh will insert the text fragments in the order in which they
appear in the XML file, with a newline following each fragment.
There are three types of remark elements, of which each may appear
multiple times:
-
Text -- Inserts literal text
-
File -- Inserts text from an external file
-
Copyright -- Generates a copyright notice
Aargh inserts the specified text without trying to verify that it
is sensible. For example, it could be binary gibberish, and
aargh wouldn't care, although your compiler would presumably
object.
More to the point, if the inserted text includes the character
sequence "*/", this sequence would terminate the comment block.
