J.3 Standard Headers


next up previous contents
Next: J.4 Modularize Up: J Guidelines for Writing Previous: J.2 Calling Sequence

J.3 Standard Headers

The following standard IDL should be included at the top of each routine. It can be found in the file $DIR_GEN_DOC/idl_template. Every line between ``;+'' and ``;-'' will be printed to the screen by the DOC_LIBRARY utility.

;+
; NAME:
; PURPOSE:
; CATEGORY:
; CALLING SEQUENCE:
; INPUTS:
; OPTIONAL INPUT PARAMETERS:
; OUTPUTS:
; OPTIONAL OUTPUT PARAMETERS:
; COMMON BLOCKS:
; SIDE EFFECTS:
; RESTRICTIONS:
; PROCEDURE:
; MODIFICATION HISTORY:
;-


ydac@mssly1.mssl.ucl.ac.uk