Skip to content

Commit b79bf43

Browse files
committed
Minor fixes to path stripping and improved deprecated code listings
Signed-off-by: Nick Avramoussis <[email protected]>
1 parent 96bd3fc commit b79bf43

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

doc/CMakeLists.txt

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,16 @@ set(DOXYGEN_EXTRACT_LOCAL_CLASSES NO)
8181
# Rather than just the file names (e.g. File.h). This makes it far
8282
# easier to navigate the docs
8383
set(DOXYGEN_FULL_PATH_NAMES YES)
84-
# Should be the same as the WORKING_DIRECTORY argument to doxygen_add_docs
85-
set(DOXYGEN_STRIP_FROM_PATH "${CMAKE_SOURCE_DIR}")
84+
set(DOXYGEN_STRIP_FROM_PATH
85+
"${CMAKE_SOURCE_DIR}/openvdb"
86+
"${CMAKE_SOURCE_DIR}/openvdb_ax"
87+
"${CMAKE_SOURCE_DIR}/openvdb_houdini"
88+
"${CMAKE_SOURCE_DIR}")
8689
set(DOXYGEN_STRIP_FROM_INC_PATH
8790
"${CMAKE_SOURCE_DIR}/openvdb"
8891
"${CMAKE_SOURCE_DIR}/openvdb_ax"
8992
"${CMAKE_SOURCE_DIR}/openvdb_houdini")
93+
9094
# Shows which source files generated the respected doxygen docs
9195
# at the bottom of each html page. Don't bother listing these.
9296
set(DOXYGEN_SHOW_USED_FILES NO)
@@ -134,6 +138,11 @@ set(DOXYGEN_PREDEFINED
134138
"OPENVDB_VERSION_NAME=v${OpenVDB_MAJOR_VERSION}_${OpenVDB_MINOR_VERSION}"
135139
"OPENVDB_ABI_VERSION_NUMBER=${OpenVDB_MAJOR_VERSION}"
136140
[[__declspec(x):= __attribute__(x):=]]
141+
# Replace the deprecated macros with doxygen deprecated comments. This ensures
142+
# that every bit of deprecated C++ is listed in the doxygen deprecated list,
143+
# even if it was not properly tagged
144+
[["OPENVDB_DEPRECATED=/** \deprecated */"]]
145+
[["OPENVDB_DEPRECATED_MESSAGE(x)=/** \deprecated x */"]]
137146
"OPENVDB_USE_LOG4CPLUS=")
138147

139148
set(DOXYGEN_ENABLED_SECTIONS "")

0 commit comments

Comments
 (0)