Skip to content

Commit 2210b5b

Browse files
committed
docs: Generate Doxygen tag files
Tag files are a feature of Doxygen that enable other projects to generate documentation that links into our published generated documentation. For example, a project with a BlazingMQ consumer that exposes `bmqa::Message` in the interface can be configured to link to our published documentation for `bmqa::Message`. It’s good practice to generate these. This patch turns on the generation of tagfiles in our documentation targets. By default, they are named `tags.xml` and put in the output directory for each of our documentation targets. Signed-off-by: Patrick M. Niedzielski <[email protected]>
1 parent 7a0fe0c commit 2210b5b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CMakeLists.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,9 @@ if(DOXYGEN_FOUND)
272272
set(DOXYGEN_ALPHABETICAL_INDEX NO)
273273
set(DOXYGEN_FULL_SIDEBAR YES)
274274
set(DOXYGEN_GENERATE_TREEVIEW YES)
275+
set(DOXYGEN_GENERATE_TAGFILE
276+
"${CMAKE_CURRENT_BINARY_DIR}/apidocs/tags.xml"
277+
)
275278
doxygen_add_docs(
276279
apidocs
277280
src/groups/bmq/bmqa
@@ -291,6 +294,9 @@ if(DOXYGEN_FOUND)
291294
set(DOXYGEN_GENERATE_TODOLIST YES)
292295
set(DOXYGEN_STRIP_FROM_PATH src/groups)
293296
set(DOXYGEN_OUTPUT_DIRECTORY internaldocs)
297+
set(DOXYGEN_GENERATE_TAGFILE
298+
"${CMAKE_CURRENT_BINARY_DIR}/internaldocs/tags.xml"
299+
)
294300
doxygen_add_docs(
295301
internaldocs
296302
src/groups/

0 commit comments

Comments
 (0)