Skip to content

Commit feda207

Browse files
committed
Enable generation of Doxygen documentation
1 parent 7a4427c commit feda207

File tree

4 files changed

+1671
-0
lines changed

4 files changed

+1671
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ tests/pdal-stats.las
33
tests/data/*.json
44
tests/pdal/capi/*Test.c
55

6+
# Ignore doxygen docs
7+
/doc/doxygen
8+
/doc/Doxyfile
9+
610
# Select VS Code configurations
711
.vscode/settings.json
812
.vscode/c_cpp_properties.json

CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ if(CMAKE_COMPILER_IS_GNUCXX)
4444
endif()
4545

4646
add_subdirectory("source/pdal/capi")
47+
add_subdirectory("doc")
4748

4849
include(CTest)
4950
add_subdirectory("tests/data")

doc/CMakeLists.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# CMake configuration file for Keryx documentation
2+
3+
find_package(Doxygen)
4+
5+
if (DOXYGEN_FOUND)
6+
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in" "${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile")
7+
8+
add_custom_target( "${PROJECT_NAME}_doxygen" ALL
9+
COMMAND ${DOXYGEN_EXECUTABLE} "${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile"
10+
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
11+
COMMENT "Generating API documentation with Doxygen"
12+
VERBATIM )
13+
14+
install(DIRECTORY doxygen DESTINATION doc)
15+
else()
16+
message(STATUS "Could not generate ${PROJECT_NAME} API help documentation: Doxygen not found")
17+
endif()

0 commit comments

Comments
 (0)