Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Better" parsing of enum values #92

Open
krister-ts opened this issue Oct 4, 2023 · 2 comments
Open

"Better" parsing of enum values #92

krister-ts opened this issue Oct 4, 2023 · 2 comments
Labels
Improvement New feature or request
Milestone

Comments

@krister-ts
Copy link

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,
};
@silvester747
Copy link
Collaborator

That is an interesting use case. Currently, it is indeed not supported. I am refactoring the internal model for 0.9.x to prepare for the 1.0 release. I will take this into account and try to have it supported as well.

@silvester747 silvester747 added the Improvement New feature or request label Oct 16, 2023
@silvester747 silvester747 added this to the 0.9.x Delilah milestone Oct 16, 2023
@krister-ts
Copy link
Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants