@param Tag

The @param tag can be used to document parameters of a function. The first word specified after the tag must be the name of the parameter it corresponds to, which is then followed by a description of the parameter. These descriptions are visible in tooltips in the Add/Edit Test Function dialog on the XJRunner Setup screen.

/// This function programs a device using a specified file.
///
/// @param path This is a filename which specifies the file to program.
/// @param result Returns RESULT_PASS on success.
///
GLOBAL ProgramFromFile(STRING path)(INT result)
  // ...
END;

@filename Tag

Parameters can be marked as filenames using the @filename tag. This means that a Browse... button will be displayed in the Edit Test Function dialog, allowing the path for the function parameter to be specified more easily. The @filename tag can be placed anywhere between the @param tag to which it refers and the next tag (if any).

Only parameters of type STRING may have the @filename tag specified.

/// This function programs a device using a specified file.
///
/// @param path @filename This is a filename which specifies the file to program.
/// @param result Returns RESULT_PASS on success.
///
GLOBAL ProgramFromFile(STRING path)(INT result)
  // ...
END;