Add Doxygen configuration for API documentation#492
Add Doxygen configuration for API documentation#492oneDiversifiedAnthony wants to merge 1 commit into
Conversation
|
Why do we need this? we already have doxygen support. ninja docs will invoke it (or ninja doc, can't remember) |
|
Thanks for the feedback! You're right that Broader input coverage:
Better preprocessing & navigation:
Housekeeping:
Happy to merge these improvements into the existing |
thanks for the clarification. yes, updating the current mecanism would avoid having duplication of doxyfiles. |
|
you will need to amend your commits and sign them off (--signoff) and then force-push them on your branch. That's why the DCO fails. |
Update Doxyfile.in with broader input coverage (tools/, utils/, docs/), include paths, image paths, search engine, cross-references, source tooltips, preprocessor macros, and warning log. Update CMakeLists.txt to output to source-root Doxygen/ directory. Remove standalone Doxyfile. Add Doxygen/ to .gitignore. Signed-off-by: Anthony Kuzub <akuzub@onediversified.com>
oneDiversifiedAnthony
force-pushed
the
feature/add-doxygen-config
branch
from
ea719f3 to
36ca2af
Compare
vt-tv
left a comment
vt-tv
left a comment
There was a problem hiding this comment.
See comment about doxygen output folder.
| set(DOXYGEN_OUTPUT_DIR "${CMAKE_CURRENT_SOURCE_DIR}/Doxygen") | ||
| configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY) | ||
|
|
||
| set(DOXYGEN_OUTPUT_DIR "${CMAKE_BINARY_DIR}/docs") |
There was a problem hiding this comment.
would it be possible to keep this path? it is also picked up when creating the rpm/deb files (ninja package)
KimonHoffmann
left a comment
KimonHoffmann
left a comment
There was a problem hiding this comment.
Thank you for applying the changes to Doxygen.in.
Like @vt-tv suggested I would also like to keep the path as before. As a result the change to .gitignore would of course become unnecessary and should be reverted as well.
3 participants
Summary
Doxyfileconfigured for the MXL project, covering public API headers, internal source, fabrics, tools, and utilsDoxygen/output directory to.gitignoreto keep generated docs out of the repositoryREADME.mdas the main page, includes alldocs/*.mdmarkdown filesUsage
Run from the project root to generate documentation:
Output is generated to
Doxygen/html/index.html.Test plan
doxygen Doxyfileand verify HTML output is generated inDoxygen/html/Doxygen/html/index.htmland verify navigation, source browsing, and search workDoxygen/directory is excluded from git tracking