Skip to content

Commit

Permalink
Teach build system to build Doxygen docs
Browse files Browse the repository at this point in the history 
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 <[email protected]>
  • Loading branch information
@pniedzielski
pniedzielski committed Nov 7, 2024
1 parent b909a17 commit 91c6c66
Showing 1 changed file with 97 additions and 0 deletions.
97 changes: 97 additions & 0 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,103 @@ else()
endif()
endif()

find_package(Git)
if(GIT_FOUND)
execute_process(
COMMAND ${GIT_EXECUTABLE} describe HEAD
WORKING_DIRECTORY "${local_dir}"
OUTPUT_VARIABLE PROJECT_VERSION
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
endif()

# -----------------------------------------------------------------------------
# DOCUMENTATION
# -----------------------------------------------------------------------------

find_package(Doxygen)
if(DOXYGEN_FOUND)
add_custom_target(docs
ALL
COMMENT "Build public and internal documentation"
)

# API Documentation for libbmq

# Each CMake variable `DOXYGEN_something` becomes a Doxygen configuration
# named `something`.
set(DOXYGEN_ALIASES
"bbref{1}=@ref BloombergLP::\\1 \\\"\\1\\\""
)
set(DOXYGEN_EXTRACT_ALL YES)
set(DOXYGEN_EXTRACT_STATIC YES)
set(DOXYGEN_EXCLUDE_PATTERNS *.t.cpp *.cpp)
set(DOXYGEN_EXCLUDE_SYMBOLS
BloombergLP::bmqimp
BloombergLP::bmqp
BloombergLP::bslmt
BloombergLP::bmqst
)
set(DOXYGEN_SHOW_INCLUDE_FILES NO)
set(DOXYGEN_SORT_MEMBER_DOCS NO)
set(DOXYGEN_PREDEFINED
"BSLS_KEYWORD_FINAL=final"
"BSLS_KEYWORD_DELETED=delete"
"BSLS_KEYWORD_OVERRIDE=override"
"BSLMF_NESTED_TRAIT_DECLARATION(..)="
)
set(DOXYGEN_EXPAND_AS_DEFINED
"BSLS_ASSERT_SAFE_IS_ACTIVE=1"
"BSLS_COMPILER_FEATURES_SUPPORT_GENERALIZED_INITIALIZERS"
"BSLS_LIBRARYFEATURES_HAS_CPP17_BASELINE_LIBRARY"
"BSLS_LIBRARYFEATURES_HAS_CPP11_UNIQUE_PTR"
)
set(DOXYGEN_SHOW_NAMESPACES NO)
set(DOXYGEN_REPEAT_BRIEF YES)
set(DOXYGEN_INLINE_INHERITED_MEMB YES)
set(DOXYGEN_STRIP_FROM_PATH src/groups/bmq)
set(DOXYGEN_OUTPUT_DIRECTORY apidocs)
set(DOXYGEN_IMAGE_PATH docs/assets/images)
set(DOXYGEN_PROJECT_ICON docs/favicon.ico)
set(DOXYGEN_PROJECT_LOGO docs/assets/images/blazingmq_logo.svg)
set(DOXYGEN_PROJECT_NAME libbmq)
set(DOXYGEN_PROJECT_BRIEF
"C++ SDK for BlazingMQ clients and plugins"
)
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE ./README.md)
set(DOXYGEN_REFERENCED_BY_RELATION YES)
set(DOXYGEN_REFERENCES YES)
set(DOXYGEN_ALPHABETICAL_INDEX NO)
set(DOXYGEN_FULL_SIDEBAR YES)
set(DOXYGEN_GENERATE_TREEVIEW YES)
doxygen_add_docs(
apidocs
src/groups/bmq/bmqa
src/groups/bmq/bmqt
src/groups/bmq/bmqpi
README.md
COMMENT "Generate public Doxygen documentation for libbmq"
)
add_dependencies(docs apidocs)

# Internal documentation for both libbmq and libmqb.

unset(DOXYGEN_EXCLUDE_SYMBOLS)
set(DOXYGEN_EXTRACT_PRIVATE YES)
set(DOXYGEN_SHOW_INCLUDE_FILES YES)
set(DOXYGEN_SHOW_NAMESPACES YES)
set(DOXYGEN_GENERATE_TODOLIST YES)
set(DOXYGEN_STRIP_FROM_PATH src/groups)
set(DOXYGEN_OUTPUT_DIRECTORY internaldocs)
doxygen_add_docs(
internaldocs
src/groups/
COMMENT "Generate internal Doxygen documentation for libbmq and libmqb"
)
add_dependencies(docs internaldocs)
endif()

# -----------------------------------------------------------------------------
# PROJECTS
# -----------------------------------------------------------------------------
Expand Down

0 comments on commit 91c6c66

Please sign in to comment.