Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build: Teach build system to build Doxygen docs #503

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Build: Teach build system to build Doxygen docs #503

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
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
Loading