Aargh

The File Element

The File element identifies an external file whose contents will be inserted into the comment block at the head of a generated source file. Typically this text would contain information applying to multiple files in the project, such as licensing conditions. For example:
<which="implementation" name="gpl_notice.txt"/>

Attributes

The File element must carry a name attribute identifying the name of the file to be inserted, possibly including a full or relative path. Any environmental variables in the file name will be expanded in the usual way. Aargh will report an error if it cannot open the specified file.

Like other elements within the Remarks aggregate, the File 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 referenced text into both generated files.

Enclosed Elements

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


Home