Skip to content

Add the documentation of Vulk #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BenjaminPraud wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add the documentation of Vulk #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
263df09
feat: add start of documentation
BenjaminPraud Feb 27, 2022
f8c09f8
feat: generate doc at the build if option enabled
BenjaminPraud Feb 27, 2022
616444c
feat: add comments for doxygen
BenjaminPraud Feb 28, 2022
bfc68da
feat: add color struct & tests (#42)
rmaxi-me Feb 28, 2022
53704c8
doc: add more detailed documentation
BenjaminPraud Feb 28, 2022
8321927
doc: document color, time and frame manager
rmaxi-me Feb 28, 2022
e838f2c
doc: improve doc for keyboard and mouse
rmaxi-me Feb 28, 2022
b5fffbe
doc: generate Doxygen files
rmaxi-me Feb 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ include(cmake/options.cmake) # *needs to be first*
include(cmake/warnings.cmake)
include(cmake/flags.cmake)
include(cmake/functions.cmake)
include(cmake/Doxygen.cmake)
enable_doxygen()

if (${CMAKE_BUILD_TYPE} MATCHES "Release" AND ${${PROJECT_PREFIX}_ENABLE_IPO})
include(CheckIPOSupported)
Expand All @@ -42,4 +44,4 @@ add_subdirectory(lib)
add_subdirectory(example-app)
if (${PROJECT_PREFIX}_ENABLE_TESTING)
add_subdirectory(tests)
endif()
endif()
24 changes: 24 additions & 0 deletions cmake/Doxygen.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
function(enable_doxygen)
option(ENABLE_DOXYGEN "Enable doxygen doc builder" OFF)

if (ENABLE_DOXYGEN)
find_package(Doxygen)
if (NOT DOXYGEN_FOUND)
message(FATAL_ERROR "Doxygen is not installed")
endif()

set(DOXYGEN_CALLER_GRAPH ON)
set(DOXYGEN_CALL_GRAPH ON)
set(DOXYGEN_EXTRACT_ALL ON)

configure_file(${CMAKE_SOURCE_DIR}/documentation/Doxyfile.in ${CMAKE_BINARY_DIR}/documentation/Doxyfile @ONLY)

add_custom_target(
doc_doxygen ALL
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/documentation/Doxyfile
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
COMMENT "Generating documentation with doxygen"
VERBATIM
)
endif()
endfunction()
1 change: 1 addition & 0 deletions conanfile.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ glm/0.9.9.8
glfw/3.3.6
shaderc/2021.1 # (glslc)
gtest/cci.20210126
doxygen/1.9.2

## These could be used for examples or the lib itself... We will disable them for now.
# fmt/8.0.1
Expand Down
Loading