Aargh

The Copyright Element

The Copyright element tells aargh to generate a copyright notice for the current system year. For example: 
<Copyright which="both" author="Fred Smith"\>
The generated copyright notice will look like this:
Copyright Fred Smith 2006 All rights reserved
You could also use the Text element to include a copyright notice. The advantage of using the Copyright element is that aargh will automatically insert the current system year.

Attributes

The File element must carry an author attribute identifying the owner of the copyright (which may or may not be the same as the author).

Like other elements within the Remarks aggregate, the Copyright element may also carry a which attribute indicating whether the referenced 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 copyright notice into both generated files.

Enclosed Elements

The Copyright element may enclose no other elements, except of course for XML comments.

Home