Minimal doxygen build added, CAC 210401 (#103)

sources/CMakeLists.txt

@@ -43,6 +43,8 @@ set(LIBXTRXLL_INCLUDE_DIRS  ${CMAKE_CURRENT_SOURCE_DIR}/libxtrxll CACHE INTERNAL
 add_subdirectory(libxtrx)
 add_subdirectory(xtrx_linux_pcie_drv)
 
+add_subdirectory(docs)
+
 ########################################################################
 # package generator
 ########################################################################

sources/docs/CMakeLists.txt

@@ -0,0 +1,24 @@
+# from https://vicrucann.github.io/tutorials/quick-cmake-doxygen/
+
+option(BUILD_DOC "Build documentation" ON)
+
+# check if Doxygen is installed
+find_package(Doxygen)
+if (DOXYGEN_FOUND)
+    # set input and output files
+    set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/../docs/Doxyfile.in)
+    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+    # request to configure the file
+    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+    message("Doxygen build started")
+
+    # note the option ALL which allows to build the docs together with the application
+    add_custom_target( doc_doxygen ALL
+        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating API documentation with Doxygen"
+        VERBATIM )
+else (DOXYGEN_FOUND)
+  message("Doxygen needs to be installed to generate doxygen documentation")
+endif (DOXYGEN_FOUND)

sources/docs/Doxyfile.in

@@ -0,0 +1,23 @@
+PROJECT_NAME           = "Fairwaves XTRX Software Defined Radio"
+PROJECT_BRIEF          = "FPGA images, pre-compiled binaries, source and software documentation"
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO           = "@CMAKE_CURRENT_SOURCE_DIR@/xtrx.jpg"
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY       = "@CMAKE_CURRENT_BINARY_DIR@"
+INPUT                  = "@CMAKE_CURRENT_SOURCE_DIR@/.."
+
+RECURSIVE              = YES
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = YES
+EXTRACT_STATIC         = YES
+EXTRACT_LOCAL_CLASSES  = YES