docprog

 
Creates the documentation for SAS programs

%docprog (prgname=program name);

WhereIs Type...And represents...
prgnameC
(optional)
SAS program name.  If this is left blank, docprog will apply this for all programs defined in the program object.
inlibLIBNAMELibrary referencing the location of the Trialex data object.

Details
This generates the program documentation.  It is required that the variable definition blocking be done before this program documentation.   This way, the documentation can properly highlight the program code.

This utility will create a new file named: prg_prgname.html for each program documented on the web server.  The prgname will be replaced with the program name. 

The following is an example of the html output file:
docprog1.jpg (82237 bytes)

Note that the program is highlighted with sections pertaining to the variable definition and SAS definition.  If the variable has multiple parts, a hyperlink labeled "continue..." is available.  Due to this color coded highlighting method, the tool has the following limitation during the definition:

  • Multiple variable definition of the same block should be defined on the same line as shown here:

    %*<Variable Definition: a_joe.ae3,a_ae.ae>*;
  • Definition blocks have to be distinct continuous sections.  Over lapping of one definition on top of another is not allowed.
  • Multiple definition blocks per variable are allowed with the same restrictions as above.

Example

%docprog;

%docprog(prgname=ae.sas);
 

 
     Meta-Xceed Inc.© 2007