mirror/json-c
1
0
Fork 0
mirror of https://github.com/json-c/json-c.git synced 2026-04-02 03:49:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #545 from dota17/make_doc

Browse Source 
add doc target in cmake
This commit is contained in:
Eric Haszlakiewicz
2020-02-26 20:56:22 -05:00
committed by GitHub
parent 5a2b9139f9 e3b6521baa
commit 30e00cf757
2 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
CMakeLists.txt
View File

@@ -317,6 +317,24 @@ set(JSON_C_SOURCES
include_directories(${PROJECT_SOURCE_DIR}) include_directories(${PROJECT_SOURCE_DIR})
include_directories(${PROJECT_BINARY_DIR}) include_directories(${PROJECT_BINARY_DIR})
# generate doxygen documentation for json-c API
find_package(Doxygen)
option(BUILD_DOCUMENTATION "Create and install the HTML based API documentation(requires Doxygen)" ${DOXYGEN_FOUND})
if (DOXYGEN_FOUND)
add_custom_target(doc
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
# request to configure the file
configure_file(Doxyfile Doxyfile)
else (DOXYGEN_FOUND)
message("Doxygen need to be installed to generate the doxygen documentation")
endif(DOXYGEN_FOUND)
# XXX for a normal full distribution we'll need to figure out # XXX for a normal full distribution we'll need to figure out
# XXX how to build both shared and static libraries. # XXX how to build both shared and static libraries.
# Probably leverage that to build a local VALGRIND=1 library for testing too. # Probably leverage that to build a local VALGRIND=1 library for testing too.

8
README.md
View File

@@ -230,6 +230,14 @@ JSONC_TEST_TRACE=1 make test
``` ```
and check the log files again. and check the log files again.
To get doxygen documentation
The libray documentation can be generated directly from the source codes using Doxygen tool:
```sh
make doc
google-chrome ../doc/html/index.html
```
Linking to `libjson-c` <a name="linking"> Linking to `libjson-c` <a name="linking">