Skip to content

Add API documentation for the C API #33

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
Jan-Joost Spanjers (jspanjers) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add API documentation for the C API #33

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
1 change: 1 addition & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ project(inflatelib

# "Production" options
option(INFLATELIB_BUILD_SHARED "Build inflatelib as a shared library" OFF)
option(INFLATELIB_API_DOC "Generate API documentation" OFF)

# "Test" options
option(INFLATELIB_TEST "Build tests for local development and CI validation" ON)
Expand Down
31 changes: 31 additions & 0 deletions src/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
include(GNUInstallDirs)

add_subdirectory(lib)

if (INFLATELIB_API_DOC)
find_package(Doxygen REQUIRED doxygen dot)

set(DOXYGEN_PROJECT_NAME "InflateLib")
set(DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES)
set(DOXYGEN_ENABLE_PREPROCESSING YES)
set(DOXYGEN_MACRO_EXPANSION YES)
set(DOXYGEN_EXPAND_ONLY_PREDEF YES)
set(DOXYGEN_PREDEFINED "INFLATELIB_CALLCONV=" "INFLATELIB_EXPORT=")

set(DOXYGEN_FULL_PATH_NAMES YES)
set(DOXYGEN_STRIP_FROM_PATH
"${PROJECT_SOURCE_DIR}/src"
"${PROJECT_SOURCE_DIR}/src/include"
)

doxygen_add_docs(inflatelib_api_docs
./index.dox
./include/inflatelib.h
ALL
USE_STAMP_FILE
)

install(
DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
DESTINATION ${CMAKE_INSTALL_DOCDIR}
COMPONENT doc
)
endif()
Loading