mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2024-10-06 12:03:35 +08:00
a40a54ec10
* Compact project relative paths from doc directory * Remove committed example_list.md - generate example_list from cmake for documentation * Fix doxygen same-line comments * Add workflow for generating documentation
24 lines
907 B
CMake
24 lines
907 B
CMake
find_package(Doxygen)
|
|
if (DOXYGEN_FOUND)
|
|
# Generate example list for documentation
|
|
set(EXAMPLE_LIST "${CMAKE_CURRENT_BINARY_DIR}/example_list.md")
|
|
file(WRITE ${EXAMPLE_LIST} "# Examples")
|
|
file(GLOB_RECURSE EXAMPLES RELATIVE ${PROJECT_SOURCE_DIR}
|
|
"${PROJECT_SOURCE_DIR}/examples/*.cpp")
|
|
foreach(EXAMPLE IN LISTS EXAMPLES)
|
|
file(APPEND ${EXAMPLE_LIST} "\n@example ${EXAMPLE}")
|
|
endforeach(EXAMPLE IN LISTS EXAMPLES)
|
|
|
|
configure_file(Doxyfile.in Doxyfile @ONLY)
|
|
|
|
# note the option ALL which allows to build the docs together with the application
|
|
add_custom_target(doc
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating API documentation with Doxygen"
|
|
VERBATIM
|
|
)
|
|
else (DOXYGEN_FOUND)
|
|
message("Doxygen need to be installed to generate the doxygen documentation")
|
|
endif (DOXYGEN_FOUND)
|