Skip to content

CMake: Add a "docs" target #343

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
thiagomacieira wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −5
Open

CMake: Add a "docs" target #343

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
5 changes: 2 additions & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,5 @@ bin
doc
lib
src/cjson
src/doxygen.log
!/Makefile
.config
/doxygen.log
/symbols.sql
10 changes: 10 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,16 @@ install(
set(PROJECT_LIBRARIES TinyCBOR)
include(PackageConfig)

find_package(Doxygen)
if(DOXYGEN_FOUND)
add_custom_target(docs
COMMAND ${CMAKE_COMMAND} -E env VERSION=${PROJECT_VERSION} ${DOXYGEN_EXECUTABLE} ${PROJECT_SOURCE_DIR}/Doxyfile
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
COMMENT "Generating documentation with Doxygen"
VERBATIM
)
endif()

if(BUILD_EXAMPLES)
add_subdirectory(examples)
endif()
Expand Down
4 changes: 2 additions & 2 deletions Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
PROJECT_NAME = "TinyCBOR $(VERSION) API"
OUTPUT_DIRECTORY = ../doc
OUTPUT_DIRECTORY = doc
ABBREVIATE_BRIEF =
SHORT_NAMES = YES
JAVADOC_AUTOBRIEF = YES
Expand All @@ -18,7 +18,7 @@ GENERATE_DEPRECATEDLIST= NO
SHOW_USED_FILES = NO
WARN_IF_UNDOCUMENTED = NO
WARN_LOGFILE = doxygen.log
INPUT = .
INPUT = src
FILE_PATTERNS = *.h \
*.c \
*.dox
Expand Down
Loading