See also:Javadoc like technical documentation for CAPRI
That work step prepares a Javadoc like HTML based documenation for the GAMS code used by CAPRI. It uses special files generated by GAMS compiler called expand (EXP) and reference (REF) files to gain information about the files and symbols used by a GAMS application.
These files can either be generated manually by invoking GAMS with the appropriate command options. Alternatively, the batch execution facility allows to generate these files.
The input files must all be found in one directory shown in the field after "Directory with input files", which can be set by pressing the "Set directory" button at the end of the line.
The current content of the directory is shown in window next to "List of available EXP and REF files. The user can select their the files used as input for the HTML generation.
Output is directed to the directory found in the field after "Directory with input files", which can be changed with the "Set directory" button at the end of the line.
The HTML code generation is started with the button at the bottom of the window "Generate HTML documentation". Please make sure that at least one ref file is selected. The window will report:
You need a HTML browser to see the results.
The documentation system is still under development.