Example: documenting ENHANCE.EAS

The DOC statement can be used to add on-line documentation to the ENHANCE script. Such documentation could include a general description of the function of the script, specification of its input parameters, and/or an example of its use.

 DOC
 DOC ENHANCE
 DOC
 DOC Given an input file and channel number, create a new
 DOC file containing a 512x512 sized copy of the input with
 DOC equalization enhancement applied.
 DOC
 DOC 1 PARAMETERS
 DOC
 DOC ENHANCE requires the following input parameters:
 DOC
 DOC Name Prompt Count Type
 DOC
 DOC FILI Name of input file to be processed 1-64 Char
 DOC DBIC Database Input File Name 0-1 Int
 DOC FILO Name of output file to be created 1-64 Char
 DOC
 DOC 2 FILI
 DOC
 DOC The name of the input file from which data will be enhanced.
 DOC
 DOC 2 DBIC
 DOC
 DOC The channel within the input file which is to be enhanced.
 DOC
 DOC 2 FILO
 DOC
 DOC The new file to create which will be of size 512x512, and contain
 DOC a single channel with the enhanced (by equalization) input data.
 DOC
 DOC 1 EXAMPLE
 DOC
 DOC Enhance the contents of channel 3 of a file called "File2Enhance.pix",
 DOC creating and putting the results in a file called "EnhancedFile.pix".
 DOC
 DOC FILI = "File2Enhance.pix"
 DOC DBIC=3
 DOC FILO= "EnhancedFile.pix"
 DOC
 DOC RUN ENHANCE
 DOC_END

With the documentation added, the user of the ENHANCE script will be able to easily get help on the usage of the script using the HELP command:

EASI>help enhance