diff options
| author |   Alberto Compagno <acompagn+fdio@cisco.com> | 2020-05-05 12:12:21 +0200 |
|---|---|---|
| committer | Alberto Compagno <acompagn+fdio@cisco.com> | 2020-05-06 16:44:34 +0200 |
| commit | 485474ec0bcd5fd73743a040cbad326a458e6390 (patch) | |
| tree | bca81977a66d96f9e0a29e2e522a64f93d7767f0 /lib | |
| parent | 43d0ecbb1a1f7e1f72bf85441547b1678aed4350 (diff) | |
[HICN-606] Added doxygen documentation
Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
Change-Id: If2bf7f4f310adf6adbbb9ea29eafcb2a0ee40d54
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | lib/doc/CMakeLists.txt | 35 | ||||
| -rw-r--r-- | lib/doc/Doxyfile.in | 12 |
3 files changed, 0 insertions, 48 deletions
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt index 3cc40bb7f..0512b7c64 100644 --- a/lib/CMakeLists.txt +++ b/lib/CMakeLists.txt @@ -48,5 +48,4 @@ endif () add_subdirectory(includes) add_subdirectory (src) -add_subdirectory (doc) diff --git a/lib/doc/CMakeLists.txt b/lib/doc/CMakeLists.txt deleted file mode 100644 index 135addc09..000000000 --- a/lib/doc/CMakeLists.txt +++ /dev/null @@ -1,35 +0,0 @@ -# add a target to generate API documentation with Doxygen -find_package(Doxygen) -option(BUILD_DOCUMENTATION "Create and install the HTML based API documentation (requires Doxygen)" ${DOXYGEN_FOUND}) - -if(BUILD_DOCUMENTATION) - if(NOT DOXYGEN_FOUND) - message(FATAL_ERROR "Doxygen is needed to build the documentation.") - endif() - - set(doxy_main_page ${CMAKE_CURRENT_SOURCE_DIR}/../README.md) - set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) - set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) - - # extract version from git - execute_process( - COMMAND git describe --long --match v* - WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} - OUTPUT_VARIABLE VERSION - OUTPUT_STRIP_TRAILING_WHITESPACE - ) - - if (NOT VERSION) - set(VERSION "v1.0-1-gcafe") - endif() - - configure_file(${doxyfile_in} ${doxyfile} @ONLY) - - add_custom_target(doc - COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile} - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - COMMENT "Generating API documentation with Doxygen" - VERBATIM) - - install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION share/doc OPTIONAL) -endif() diff --git a/lib/doc/Doxyfile.in b/lib/doc/Doxyfile.in deleted file mode 100644 index a28fb3a1a..000000000 --- a/lib/doc/Doxyfile.in +++ /dev/null @@ -1,12 +0,0 @@ -PROJECT_NAME = "Hybrid ICN (hICN)" -PROJECT_NUMBER = @VERSION@ -STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ \ - @PROJECT_BINARY_DIR@ -INPUT = @doxy_main_page@ \ - @PROJECT_SOURCE_DIR@ \ - @PROJECT_BINARY_DIR@ -FILE_PATTERNS = *.md \ - *.h \ - *.cc -RECURSIVE = YES -USE_MDFILE_AS_MAINPAGE = @doxy_main_page@ |