ADD-DOCUMENTATION - Add documentation lines

Function

The //ADD-DOCUMENTATION statement allows message units to be documented. The documentation lines are assigned to the message units via the message code. In addition to the persons responsible for the message file, a 60-character comment can also be entered.
The correctness of the documentation and its relation to the messages are not checked.

If messages that have already been documented are documented again, the default setting in the //MODIFY-OPTION statement determines whether the documentation can be overwritten.

Differences compared with the //ADD-DOCUMENTATION statement in menu mode

The //ADD-DOCUMENTATION statement which can be entered in the command area of the screen mask differs from the //ADD-DOCUMENTATION statement in command procedures in that in menu mode, the operand value *PANEL-REQUEST can be assigned to any operand.

For further details, see section “Special features of statements in menu mode”.

Format

ADD-DOCUMENTATION                                                                                                                                

MSG-ID = *INTERVAL(...) / <name 7..7>
	*INTERVAL(...)
		|	FROM = <name 7..7>
		|	,TO = <name 7..7>
,OWNER = *NONE / *PARAMETERS(...)
	*PARAMETERS(...)
		|	NAME = *NONE / <c-string 1..20>
		|	,TEAM = *NONE / <c-string 1..15>
,COMMENTS = *NONE / <c-string 1..60>

Operands

MSG-ID = *INTERVAL(...) / <name 7..7>
Name of one or more message units to be documented.

MSG-ID = <name 7..7>
The full message code, consisting of the three-character message class and the four-digit message number, must be entered.

MSG-ID = *INTERVAL(...)
Designates a message range. The limit values of the range must belong to the same message class.

FROM = <name 7..7>
Designates the lower limit value of the message range (full message code).

TO = <name 7..7>
Designates the upper limit value of the message range (full message code).

OWNER = *NONE / *PARAMETERS(...)
Designates the persons responsible for the message file.

OWNER = *NONE
No specifications are made regarding the persons responsible.

OWNER = *PARAMETERS(...)

NAME = *NONE / <c-string 1..20>
Designates the person responsible for the message file.

TEAM = *NONE / <c-string 1..15>
Designates the team responsible for the message file.

COMMENTS = *NONE / <c-string 1..60>
Comment on the selected messages, comprising up to 60 characters.