From 83f830431c0577f6d17ef3396dff3da8366d811d Mon Sep 17 00:00:00 2001 From: Guilherme Maciel Ferreira Date: Sat, 30 Jul 2011 16:56:00 -0300 Subject: [PATCH] Bring aboard Doxygen documentation support --- doc/doxyfile.in | 1 + src/CMakeLists.txt | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 0 deletions(-) create mode 100644 doc/doxyfile.in diff --git a/doc/doxyfile.in b/doc/doxyfile.in new file mode 100644 index 0000000..9a52129 --- /dev/null +++ b/doc/doxyfile.in @@ -0,0 +1 @@ +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/config/ @CMAKE_CURRENT_SOURCE_DIR@/dns/ @CMAKE_CURRENT_SOURCE_DIR@/host/ @CMAKE_CURRENT_SOURCE_DIR@/icmp/ @CMAKE_CURRENT_SOURCE_DIR@/ip/ @CMAKE_CURRENT_SOURCE_DIR@/link/ @CMAKE_CURRENT_SOURCE_DIR@/tcp/ \ No newline at end of file diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 96e656a..62e0ec7 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -20,6 +20,9 @@ pkg_check_modules(I2NCOMMON REQUIRED libi2ncommon) include_directories(${I2NCOMMON_INCLUDE_DIRS}) link_directories(${I2NCOMMON_LIBRARY_DIRS}) +# package: doxygen +find_package(Doxygen) + # compiler: include directories where the source code is located include_directories(${CMAKE_CURRENT_SOURCE_DIR}) @@ -51,6 +54,21 @@ set(SOURCES main.cpp ) +# documentation: add a target to generate API documentation with Doxygen +if(DOXYGEN_FOUND) + configure_file( + ${CMAKE_SOURCE_DIR}/doc/doxyfile.in + ${CMAKE_BINARY_DIR}/doc/Doxyfile @ONLY + ) + add_custom_target( + doc + ${DOXYGEN_EXECUTABLE} + ${CMAKE_BINARY_DIR}/doc/Doxyfile + WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc + COMMENT "Generating API documentation with Doxygen" VERBATIM + ) +endif(DOXYGEN_FOUND) + # compiler: creates the binary add_executable(${TARGET} ${SOURCES}) -- 1.7.1