Allow API documentation to be built directly from Doxygen #118
Labels
A-Docs
Area: Documentation
bug
Something isn't working
documentation
Improvements or additions to documentation
Is there an existing issue for this?
Current Behavior
Our current API documentation was generated using
bde-tools
'sbdedox
executable. Since our comments are no longer in BDE-style, runningdoxygen
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
doxygen
on the codebase.BlazingMQ Version
HEAD
Anything else?
No response
The text was updated successfully, but these errors were encountered: