Skip to content

Commit

Permalink
Docs[BMQ]: Use .dox files rather than .md files
Browse files Browse the repository at this point in the history
Package group documentation in `libbmq` was converted to Markdown files
named `README.md`, and which was tied to the directory containing the
code for the package group using Doxygen `@dir` commands.  However, when
generating the documentation, this left several empty pages in the
documentation named `README`, which we were not able to remove.

The solution for this that this patch uses is to switch from `.md` files
to `.dox` files, which contain a single Doxygen-style C++ comment
containing the `@dir` command.  Unlike `.md` files, these do not
automatically create pages, so there is no empty `README` page created
for each package group.  The cost of this is that `.dox` files cannot be
simple Markdown files, but instead need to be wrapped in a C++ comment.

Signed-off-by: Patrick M. Niedzielski <[email protected]>
  • Loading branch information
pniedzielski committed Oct 7, 2024
1 parent f5b0fe2 commit 46f7b76
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 1 deletion.
3 changes: 2 additions & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -989,7 +989,8 @@ INPUT_FILE_ENCODING =
FILE_PATTERNS = *.c \
*.cpp \
*.h \
*.md
*.md \
*.dox

# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/**
@dir bmqa

@brief The `BMQA` (BlazingMQ API) package provides applications a public API

The `bmqa` package provides the public API of the BlazingMQ SDK for
applications to use.
*/
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/**
@dir bmqpi

@brief The `BMQPI` (BlazingMQ Public Interfaces) package provides class
Expand All @@ -8,3 +9,4 @@ clients to extend in their own applications and libraries. These extension
points facilitate integration with other aspects of a runtime environment (e.g.
authentication, host health-checking), which may vary significantly from
organization to organization.
*/
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
/**
@dir bmqt

@brief The `BMQT` (BlazingMQ (vocabulary) Types) package provides
value-semantic vocabulary types.

The ‘bmqt‘ package provides low level value-semantic vocabulary types for use
by the BlazingMQ SDK.
*/

0 comments on commit 46f7b76

Please sign in to comment.