#98 new tag @LICENSE

[TridenT]

[Admin Entry - from klatham]

The JEDI project has a requirement for a standard header describing the license conditions at the top of each unit. JEDI aside, this is a standard requirement for many developments.

I think it is reasonable that this be header is included in the documentation produced by DCTD. Currently the only place to code it is in the unit description, but this distracts from the description of the unit itself.

I would like to suggest a new tag: @LICENSE which would introduce the header and improve the readability of the documentation.

Since the standard header is supposed to go at the very top of the unit, I think we need an explicit @DESCRIPTION tag to continue the description definition after the standard header.

The @LICENSE info would be placed under a newly defined LICENSE header in the doco output.

example:

{***********
Delphi Pascal Translation of Rexx API Header File

@LICENSE
{ Borland Delphi Runtime Library
{ Rexx Interface unit
...
@DESCRIPTION
This unit .....

@AUTHOR ...
@VERSION ...
*}
unit rexx;
...