Merge remote-tracking branch 'origin/refresh-doxygen' into integration_2022_wk49

CMakeLists.txt

@@ -24,6 +24,11 @@
 cmake_minimum_required (VERSION 3.5)
 project (OpenAirInterface LANGUAGES C CXX)
 
+#########################################################
+# Base directories, compatible with legacy OAI building #
+#########################################################
+set (OPENAIR_DIR     ${CMAKE_SOURCE_DIR})
+
 include("cmake_targets/macros.cmake")
 
 # System packages that are required
@@ -55,15 +60,15 @@ if (${RF_BOARD} STREQUAL "OAI_USRP")
   find_package(Boost REQUIRED)
 
 elseif (${RF_BOARD} STREQUAL "OAI_IRIS")
-    include_directories("${OPENAIR_DIR}/radio/IRIS/USERSPACE/LIB/")
+    include_directories("radio/IRIS/USERSPACE/LIB/")
 
     set(HW_SOURCE ${HW_SOURCE}
-            ${OPENAIR_DIR}/radio/IRIS/USERSPACE/LIB/iris_lib.cpp)
+           radio/IRIS/USERSPACE/LIB/iris_lib.cpp)
     LINK_DIRECTORIES("/usr/local/lib")
     set(option_HW_lib "-lSoapySDR -rdynamic -ldl")
 
 elseif (${RF_BOARD} STREQUAL "OAI_AW2SORI")
-    include_directories("${OPENAIR_DIR}/radio/AW2SORI")
+    include_directories("radio/AW2SORI")
     set(HW_SOURCE ${HW_SOURCE}
 	    ${OPENAIR_DIR}/radio/AW2SORI/ARCH/AW2SORI/oaiori.c)
     LINK_DIRECTORIES("/usr/local/lib")
@@ -145,7 +150,6 @@ endif()
 #########################################################
 # Base directories, compatible with legacy OAI building #
 #########################################################
-set (OPENAIR_DIR     ${CMAKE_SOURCE_DIR})
 set (NFAPI_DIR       ${OPENAIR_DIR}/nfapi/open-nFAPI)
 set (NFAPI_USER_DIR  ${OPENAIR_DIR}/nfapi/oai_integration)
 set (OPENAIR1_DIR    ${OPENAIR_DIR}/openair1)
@@ -2852,5 +2856,6 @@ make_driver(ue_ip ${OPENAIR2_DIR}/NETWORK_DRIVER/UE_IP ${ue_ip_src})
 include (common/utils/telnetsrv/telnetsrv_CMakeLists.txt)
 include(${OPENAIR1_DIR}/PHY/CODING/nrLDPC_decoder/nrLDPC_tools/CMakeLists.txt)
 
+add_subdirectory(doc)
 add_subdirectory(openair2)
 add_subdirectory(openair3)

cmake_targets/build_oai

@@ -333,7 +333,8 @@ function main() {
             echo_info "Will compile with verbose instructions"
             shift;;
        --build-doxygen)
-	        BUILD_DOXYGEN=1
+            CMAKE_CMD="$CMAKE_CMD -DGENERATE_DOXYGEN=ON"
+            BUILD_DOXYGEN=1
             echo_info "Will build doxygen support"
             shift;;     
        --build-coverity-scan)
@@ -535,9 +536,8 @@ function main() {
       execlist="$execlist nr-uesoftmodem"
   fi
 
-  if [[ "$execlist" == "" && "$SIMUS_PHY" != "1" ]]; then
-    echo_success "installing dependencies successful"
-    exit
+  if [[ "$execlist" == "" && "$SIMUS_PHY" != "1" && "$HW" == "None" ]]; then
+    SKIP_SHARED_LIB_FLAG="True"
   fi
 
   echo_info "3. building the compilation directives ..."
@@ -727,11 +727,7 @@ function main() {
     echo_info "Doxygen generation log is located here: $doxygen_log"
     echo_info "Generating Doxygen files....please wait"
     (
-    [ "$CLEAN" = "1" ] && rm -rf $OPENAIR_DIR/cmake_targets/doxygen/build
-    mkdir -p $OPENAIR_DIR/cmake_targets/doxygen/build
-    cd $OPENAIR_DIR/cmake_targets/doxygen/build
-    eval $CMAKE_CMD ..
-    make doc
+    $MAKE_CMD doc
     ) >& $doxygen_log
   fi
 

cmake_targets/doxygen/CMakeLists.txt

@@ -1,11 +0,0 @@
-cmake_minimum_required(VERSION 2.8)
-include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)
-find_package(Doxygen)
-if(DOXYGEN_FOUND)
-configure_file(${OPENAIR_TARGETS}/DOCS/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
-add_custom_target(doc
-${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
-WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-COMMENT "Generating API documentation with Doxygen" VERBATIM
-)
-endif(DOXYGEN_FOUND)

doc/CMakeLists.txt

@@ -0,0 +1,13 @@
+add_boolean_option(GENERATE_DOXYGEN False "Generate source code doc using doxygen")
+
+if(GENERATE_DOXYGEN)
+  find_package(Doxygen REQUIRED)
+
+  configure_file(Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
+  add_custom_target(doc
+    ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+    COMMENT "Generating API documentation with Doxygen" VERBATIM
+  )
+else()
+  message(STATUS "No Doxygen documentation requested")
+endif()