fix the regressions blocking doxygen documentation generation

This commit is contained in:
Laurent THOMAS
2022-11-08 12:08:07 +01:00
committed by Robert Schmidt
parent f7c3874e20
commit 00d1114fa3
8 changed files with 4354 additions and 2505 deletions

View File

@@ -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)
@@ -3004,3 +3008,4 @@ include (${OPENAIR_DIR}/common/utils/telnetsrv/telnetsrv_CMakeLists.txt)
include(${OPENAIR1_DIR}/PHY/CODING/nrLDPC_decoder/nrLDPC_tools/CMakeLists.txt)
add_subdirectory(openair2)
add_subdirectory(doc)

View File

@@ -535,11 +535,6 @@ function main() {
execlist="$execlist nr-uesoftmodem"
fi
if [[ "$execlist" == "" && "$SIMUS_PHY" != "1" ]]; then
echo_success "installing dependencies successful"
exit
fi
echo_info "3. building the compilation directives ..."
DIR=$OPENAIR_DIR/cmake_targets
@@ -727,11 +722,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

View File

@@ -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)

15
doc/CMakeLists.txt Normal file
View File

@@ -0,0 +1,15 @@
find_package(Doxygen QUIET)
if(DOXYGEN_FOUND)
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()
add_custom_target(doc
message(FATAL_ERROR "required to generate doxygen documentation but doxygen not installed")
)
endif(DOXYGEN_FOUND)

4329
doc/Doxyfile Normal file

File diff suppressed because it is too large Load Diff

View File

Before

Width:  |  Height:  |  Size: 9.4 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

File diff suppressed because it is too large Load Diff