asciidoxy icon indicating copy to clipboard operation
asciidoxy copied to clipboard

"Better" parsing of enum values

Open krister-ts opened this issue 1 year ago • 2 comments

I'm using enum values in a very unusual way where each value is a command identifier used in a structure with fields for parameters. The identifier will define how the params are used. I have been using the @param javadoc tag to document the way the params are used for each command.

Anyways, this works in doxygen but will not work in asciidoxy (the description will be an empty string and params is also empty).

Example:

enum CmdID {
  /**
  * Dummy command (no op).
  * 
  * @param int_val_1: NULL
  * @param int_val_2: NULL
  */
  CMD_DO_NOTHING,

  /**
  * Does something.
  * 
  * @param int_val_1: First value to do something with.
  * @param int_val_2: Second value to do something with.
  * 
  * @returns Status of something.
  * @retval 0: Something is done.
  * @retval -1: Something is not done.
  */
  CMD_DO_SOMETHING,
};

krister-ts avatar Oct 04 '23 21:10 krister-ts