The programme editHelps, is a tool developed by Deltares (former Delft Hydraulics) aimed at lowering the threshold to keep the helpblocks of the various m-files up to date.

It does so by automatically analysing m-files on the presence of a number of standard elements in the helpblock (e.g. one-line explanation, brief routine summary, description of input and output arguments etc.). Change the Matlab working directory to the directory of the m-files of which the help blocks need to be updated and type editHelps (mcsettings should have been run).

Potential applications of editHelps focus on: projects where a number of m-files have been developed that qualify as potential McTools files.

Help on the help editor "editHelps" 

  • The help editor sets initially the help as complete as possible from the available help
  • The left pane shows existing help, the right pane shows the existing and prepared help combined
  • You can edit the help in the right pane
  • Possible to browse for an M-file or scroll in the current directory with the < (previous) and > (next) buttons
  • The editor checks for the function name to be the same as the file name of the M-file. (Look for the red warning when there is a difference, the file name is used and saved.)
  • Possible to Preview the body of the M-file with the new setting of the help block according to the right pane. "View As is" shows the current body of the M-file.
  • "Scroll, no changes" check box
    • not activated: when the save button is enabled, you are asked for a save before a new M-file can be selected
    • activated      : you can select another file without saving. Be carefull: changes will be lost
  • "Save original help also" check box. When activated the help as is in the file is saved following the new help block
  • Editing the parameter description is done in the box beneath the list box, for the selected parameter. When in the list box, new text is added to the current description text
  • No labels

Disclaimer