Build: Teach build system to build Doxygen docs #503
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pniedzielski
added
documentation
pniedzielski
changed the title
pniedzielski
force-pushed
the
doxygen/cmake
branch
from
91c6c66 to
913e7b8
Compare
hallfox
approved these changes
Nov 7, 2024
This patch introduces three new targets to the build system when Doxygen
is present:
- `apidocs`: Build the public API documentation for public libbmq
components. This target functions similarly to how the current
`Doxyfile` builds documentation.
- `internaldocs`: Build the internal documentation for all libbmq and
libmqb components. The documentation built by this target is
currently incomplete, and needs work along the lines of PRs bloomberg#443 and
bloomberg#444.
- `docs`: Build both the above documentation targets. This is a
dependency of `make all`, so it will run by default.
Signed-off-by: Patrick M. Niedzielski <patrick@pniedzielski.net>
pniedzielski
force-pushed
the
doxygen/cmake
branch
from
913e7b8 to
11577a0
Compare
![bmq-oss-ci[bot]](https://avatars.githubusercontent.com/u/1416818?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch introduces three new targets to the build system when Doxygen is present:
apidocs: Build the public API documentation for public libbmq components. This target functions similarly to how the currentDoxyfilebuilds documentation.internaldocs: Build the internal documentation for all libbmq and libmqb components. The documentation built by this target is currently incomplete, and needs work along the lines of PRs Docs[BMQ] bde -> doxygen conversion fixes #443 and Docs[BMQ]: Use.doxfiles rather than.mdfiles #444.docs: Build both the above documentation targets. This is a dependency ofmake all, so it will run by default.