kdu_params::describe_attributes

Generates a text description of the record structure defined for all attributes associated with the current object. This is principally intended for printing usage statements or generating descriptive text for interactive windows. However, the function could be used by an interactive dialog generator to configure parameter entry dialogs.

For a discussion of records, fields, typing and the pattern strings used to describe record structures, consult the comments appearing with the declaration of parse_string.

output [kdu_message &]

include_comments [bool]