Skip to content
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

Jump to bottom

Show correct library version in Doxygen. #725

Merged
merged 1 commit into from
Apr 9, 2024
Merged

Show correct library version in Doxygen. #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,3 +650,6 @@ docs/html/**

# clangd config file
.clangd

# this file will be generated
docs/Doxyfile
3 changes: 2 additions & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ project(
kamping
DESCRIPTION "An MPI wrapper which makes using MPI feel like C++"
LANGUAGES CXX
VERSION 1.0.0
VERSION 0.1.0
)

if (CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
Expand Down Expand Up @@ -37,6 +37,7 @@ if (CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
else ()
message(STATUS "Doxygen not found, not building docs")
endif ()
configure_file(${CMAKE_CURRENT_LIST_DIR}/docs/Doxyfile.in ${CMAKE_CURRENT_LIST_DIR}/docs/Doxyfile @ONLY)

add_subdirectory(cmake/Format.cmake)
endif ()
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile → docs/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = KaMPIng
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 0.0.1
PROJECT_NUMBER = @kamping_VERSION@

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
2 changes: 1 addition & 1 deletion docs/main.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ See `allgatherv_example.cpp` and the other files in `examples` directory for mor
- \ref kamping_mpi_utility

## Dependencies
- Building this documentation requires `Doxygen 1.9.2`.
- Building this documentation requires `Doxygen 1.10.0`.

## Guidelines
- \subpage coding_guidelines
Expand Down
Loading