Bring aboard Doxygen documentation support v1.0
authorGuilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Sat, 30 Jul 2011 19:56:00 +0000 (16:56 -0300)
committerGuilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Sat, 30 Jul 2011 19:56:00 +0000 (16:56 -0300)
doc/doxyfile.in [new file with mode: 0644]
src/CMakeLists.txt

diff --git a/doc/doxyfile.in b/doc/doxyfile.in
new file mode 100644 (file)
index 0000000..9a52129
--- /dev/null
@@ -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
index 96e656a..62e0ec7 100644 (file)
@@ -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})