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

Allow API documentation to be built directly from Doxygen #118

Open
1 task done
pniedzielski opened this issue Sep 26, 2023 · 1 comment
Open
1 task done

Allow API documentation to be built directly from Doxygen #118

pniedzielski opened this issue Sep 26, 2023 · 1 comment
Assignees
Labels
A-Docs Area: Documentation bug Something isn't working documentation Improvements or additions to documentation

Comments

@pniedzielski
Copy link
Collaborator

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

Our current API documentation was generated using bde-tools's bdedox executable. Since our comments are no longer in BDE-style, running doxygen on the codebase does not pick up several things our current published API docs have, like package group, package, and component-level documentation, some BDE formatting, and \brief descriptions automatically generated from the first sentence of a documentation comment.

Additionally, some BDE-style documentation failed to convert, as in the bmqa_abstractsession component.

Expected Behavior

Running doxygen on the codebase should produce up-to-date documentation, including all our package group, package, and component documentation, and should support Doxygen-style annotations, such as \deprecated and \par.

Steps To Reproduce

  1. Run doxygen on the codebase.
  2. Compare the output to the public API documentation.

BlazingMQ Version

HEAD

Anything else?

No response

@chrisbeard
Copy link
Contributor

Non-exhaustive to-do list for this effort:

  1. convert group and package docs in mwc to doxygen format like bmqa
  2. convert group and package docs in mqb to doxygen format (less important)
  3. add make doc target that at least generates bmq and mwc docs
  4. make the CI run this on release tags and upload it to the website
  5. go through and find places where the doxygen conversion failed to properly convert BDE style to doxygen style
  6. use doxygen tags for things like @deprecated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Docs Area: Documentation bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants