Compare commits
No commits in common. "a65bb5255e66b97d3ed63e73adefceb87ff9a34b" and "c1298f0b808ae21a7f55e6b4774809696300ef00" have entirely different histories.
a65bb5255e
...
c1298f0b80
|
@ -7,6 +7,9 @@
|
||||||
# The directory containing all build outputs.
|
# The directory containing all build outputs.
|
||||||
/build/
|
/build/
|
||||||
|
|
||||||
|
# The directory generated by `Doxygen`.
|
||||||
|
/docs/
|
||||||
|
|
||||||
# A symlink produced by default when running `nix build`.
|
# A symlink produced by default when running `nix build`.
|
||||||
result
|
result
|
||||||
|
|
||||||
|
|
|
@ -2,11 +2,10 @@ cmake_minimum_required(VERSION 3.19)
|
||||||
project(bootstrap VERSION 0.1.3 LANGUAGES C)
|
project(bootstrap VERSION 0.1.3 LANGUAGES C)
|
||||||
|
|
||||||
add_executable(bootstrap main.c)
|
add_executable(bootstrap main.c)
|
||||||
target_link_libraries(bootstrap PUBLIC m)
|
|
||||||
target_include_directories(bootstrap PUBLIC include)
|
|
||||||
|
|
||||||
add_subdirectory(src)
|
add_subdirectory(src)
|
||||||
add_subdirectory(docs)
|
target_link_libraries(bootstrap PUBLIC m)
|
||||||
|
target_include_directories(bootstrap PUBLIC include)
|
||||||
|
|
||||||
if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
|
if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
|
||||||
set_target_properties(
|
set_target_properties(
|
||||||
|
|
|
@ -251,12 +251,10 @@ $ make test
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
Documentation is generated using [Doxygen](https://www.doxygen.nl/index.html)
|
We use [doxygen](https://www.doxygen.nl/index.html) for documentation
|
||||||
(version 1.9.7) through CMake. (Re)generate documentation by navigating to
|
generation. Run the following command to generate documentation locally:
|
||||||
the desired build configuration directory and running:
|
|
||||||
```bash
|
```bash
|
||||||
$ cmake --build .
|
$ doxygen
|
||||||
$ make docs
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Formatting
|
### Formatting
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
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)
|
|
|
@ -1,2 +0,0 @@
|
||||||
INPUT = "@DOXYGEN_INPUT_DIR@"
|
|
||||||
GENERATE_LATEX = NO
|
|
|
@ -7,6 +7,9 @@
|
||||||
# The directory containing all build outputs.
|
# The directory containing all build outputs.
|
||||||
/build/
|
/build/
|
||||||
|
|
||||||
|
# The directory generated by `Doxygen`.
|
||||||
|
/docs/
|
||||||
|
|
||||||
# A symlink produced by default when running `nix build`.
|
# A symlink produced by default when running `nix build`.
|
||||||
/result
|
/result
|
||||||
|
|
||||||
|
|
|
@ -15,9 +15,6 @@ add_executable("<NAME>" main.c)
|
||||||
# for linking the other project source files to our executable.
|
# for linking the other project source files to our executable.
|
||||||
add_subdirectory(src)
|
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`.
|
# An example on linking additional libraries. In this case, links `math`.
|
||||||
target_link_libraries("<NAME>" PUBLIC m)
|
target_link_libraries("<NAME>" PUBLIC m)
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -41,11 +41,10 @@ exists and points to this generated database.
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Documentation is generated using [Doxygen](https://www.doxygen.nl/index.html)
|
Documentation is generated using [Doxygen](https://www.doxygen.nl/index.html)
|
||||||
(version 1.9.7) through CMake. (Re)generate documentation by navigating to
|
(version 1.9.7). (Re)generate documentation by editing the `Doxyfile` and
|
||||||
the desired build configuration directory and running:
|
running:
|
||||||
```bash
|
```bash
|
||||||
$ cmake --build .
|
$ doxygen
|
||||||
$ make docs
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
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)
|
|
|
@ -1 +0,0 @@
|
||||||
INPUT = "@DOXYGEN_INPUT_DIR@"
|
|
Loading…
Reference in New Issue