We are now using Doxygen to document the Open GENIE GCL language. As Doxygen does not understand GCL directly, it is first pre-processed into C language like code which is then parsed by Doxygen. A side effect of this is that the documentation produced for the commands is written out in a C function like syntax, but it is easy enough to relate this back to more familiar GCL syntax.
In OpenGENIE a command qualifier and a boolean parameter are equivalent, so if a COMMAND can take two qualifier /QUAL1 and /QUAL2 then writing
COMMAND /QUAL1
is equivalent to
COMMAND QUAL1=$TRUE QUAL2=$FALSE
In the function documentation, qualifiers are listed as if they were function arguments and are given the data type Qualifier. For example see ISC_SETUP. If the parameters for a function must always be of a specific type e.g. Integer or String, this is also listed. If the parameter may be of differnt type depending on the usage of the command, then its type will be listed as Generic and you will need to refer to the documentation for valid choices.
All open GENIE procedures can be called in command or function syntax i.e.
COMMAND /QUAL1 4.0
or
RESULT = COMMAND:QUAL1(4.0)
In the documentation only the function syntax is referred to, but that does not mean the command syntax cannot be used.
1.6.1
