Skip to content

Commit

Permalink
docs: Exclude internal namespaces
Browse files Browse the repository at this point in the history
In several places in our SDK, we need to forward declare a symbol from
one of the implementation packages (e.g., `bmqimp`).  These packages do
not form part of the public API of `libbmq`, and we do not want to
include them in the documentation.  Unfortunately, it looks like the
best way to do this is to manually and explicitly exclude the namespaces
for these symbols in the `Doxyfile`.  This patch excludes the namespaces
of components outside of `bmqa`, `bmqpi`, and `bmqt` that we need to
forward-declare, including private `libbmq` packages and BDE packages.

Signed-off-by: Patrick M. Niedzielski <[email protected]>
  • Loading branch information
pniedzielski committed Apr 17, 2024
1 parent f59437e commit 9b033c2
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1029,7 +1029,9 @@ EXCLUDE_PATTERNS = *.t.cpp \
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# ANamespace::AClass, ANamespace::*Test

EXCLUDE_SYMBOLS =
EXCLUDE_SYMBOLS = BloombergLP::bmqimp \
BloombergLP::bmqp \
BloombergLP::bslmt

# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
Expand Down

0 comments on commit 9b033c2

Please sign in to comment.