Use CMake Doxygen package from clang.

pull/1/head
Joshua Potter 2024-01-06 10:59:26 -07:00
parent b557dadd3f
commit a65bb5255e
6 changed files with 32 additions and 2809 deletions

View File

@ -7,9 +7,6 @@
# The directory containing all build outputs.
/build/
# The directory generated by `Doxygen`.
/docs/
# A symlink produced by default when running `nix build`.
/result

View File

@ -15,6 +15,9 @@ add_executable("<NAME>" main.c)
# for linking the other project source files to our executable.
add_subdirectory(src)
# Use the Doxygen module to generate documentation through CMake.
add_subdirectory(docs)
# An example on linking additional libraries. In this case, links `math`.
target_link_libraries("<NAME>" PUBLIC m)

File diff suppressed because it is too large Load Diff

View File

@ -41,10 +41,11 @@ exists and points to this generated database.
## Documentation
Documentation is generated using [Doxygen](https://www.doxygen.nl/index.html)
(version 1.9.7). (Re)generate documentation by editing the `Doxyfile` and
running:
(version 1.9.7) through CMake. (Re)generate documentation by navigating to
the desired build configuration directory and running:
```bash
$ doxygen
$ cmake --build .
$ make docs
```
## Testing

View File

@ -0,0 +1,24 @@
find_package(Doxygen REQUIRED)
set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/include)
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
add_custom_command(OUTPUT
${DOXYGEN_INDEX_FILE}
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
COMMENT "Generating Doxygen documentation"
VERBATIM
)
add_custom_target(docs DEPENDS ${DOXYGEN_INDEX_FILE})
# Ensure worker is built before documentation.
add_dependencies(docs bootstrap)

View File

@ -0,0 +1 @@
INPUT = "@DOXYGEN_INPUT_DIR@"