Parameter documentation fixing-up

[MatthewWhiting]

Things to fix from talking with Kelvin:

• Add datatypes to parameter descriptions in Guide
• Ranges of parameters?
  • Does this need to go in Guide? Do we need it for the GUI?
• Add section headings to InputComplete, as these are used by the parameter-setting-GUI
  • Format: ### OUTPUT RELATED

[MatthewWhiting]

Updated InputComplete to include datatypes and some description of the range of acceptable values (where appropriate). This should help it be parsed by the GUI software. Each line describing a parameter starts with #*.

The following python code should allow reading & parsing of one of these lines:

def parseParamString(s):
    param=s.split()[1]
    dtype=s.partition('[')[2].partition(']')[0]
    format=s.partition('{')[2].partition('}')[0]
    desc=s.partition('{')[2].partition('}')[2][4:]
    print '%s [%s] - %s\n\t%s'%(param,dtype,format,desc)

Have also added in the section headers as described.

[1320] updates this in trunk - yet to do so in the GUIdev branch

[MatthewWhiting]

[1322] and [1323] put this information into the User Guide, in the format of

\item[{ImageFile [no default | string | filename]}] The filename of the data cube to be analysed.
\item[{flagSubsection [false | bool | true/false/1/0]}] A flag to indicate whether one wants a subsection of the requested image.

[MatthewWhiting]

All done for now. Closing.