maki/openairinterface5g
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen: explicit cmake option, more corrections

Browse Source 
- Correct log message for directory of generated doxygen doc
- Correct path for image
- Skip to build libraries if not requested
This commit is contained in:
Robert Schmidt
2022-12-07 15:45:12 +01:00
parent 00d1114fa3
commit 9baeae540b
3 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmake_targets/build_oai
+6 -1
View File
@@ -333,7 +333,8 @@ function main() {
echo_info "Will compile with verbose instructions" echo_info "Will compile with verbose instructions"
shift;; shift;;
--build-doxygen) --build-doxygen)
BUILD_DOXYGEN=1 CMAKE_CMD="$CMAKE_CMD -DGENERATE_DOXYGEN=ON"
BUILD_DOXYGEN=1
echo_info "Will build doxygen support" echo_info "Will build doxygen support"
shift;; shift;;
--build-coverity-scan) --build-coverity-scan)
@@ -535,6 +536,10 @@ function main() {
execlist="$execlist nr-uesoftmodem" execlist="$execlist nr-uesoftmodem"
fi fi
if [[ "$execlist" == "" && "$SIMUS_PHY" != "1" && "$HW" == "None" ]]; then
SKIP_SHARED_LIB_FLAG="True"
fi
echo_info "3. building the compilation directives ..." echo_info "3. building the compilation directives ..."
DIR=$OPENAIR_DIR/cmake_targets DIR=$OPENAIR_DIR/cmake_targets
doc/CMakeLists.txt
+6 -8
View File
@@ -1,15 +1,13 @@
add_boolean_option(GENERATE_DOXYGEN False "Generate source code doc using doxygen")
find_package(Doxygen QUIET) if(GENERATE_DOXYGEN)
find_package(Doxygen REQUIRED)
if(DOXYGEN_FOUND)
configure_file(Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) configure_file(Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(doc add_custom_target(doc
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
COMMENT "Generating API documentation with Doxygen" VERBATIM COMMENT "Generating API documentation with Doxygen" VERBATIM
) )
else() else()
add_custom_target(doc message(STATUS "No Doxygen documentation requested")
message(FATAL_ERROR "required to generate doxygen documentation but doxygen not installed") endif()
)
endif(DOXYGEN_FOUND)
doc/Doxyfile
+2 -2
View File
@@ -51,14 +51,14 @@ PROJECT_BRIEF = "Full experimental OpenSource LTE and NR implementation
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory. # the logo to the output directory.
PROJECT_LOGO = images/oai_logo.png PROJECT_LOGO = @CMAKE_SOURCE_DIR@/doc/oai_logo.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # 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 # 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 # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = GeneratedDoc #OUTPUT_DIRECTORY = .
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and # directories (in 2 levels) under the output directory of each output format and