diff options
| author | Tatiana Borisova <tatiana.borisova@qt.io> | 2025-11-26 19:04:59 +0100 |
|---|---|---|
| committer | Tatiana Borisova <tatiana.borisova@qt.io> | 2025-12-16 12:48:09 +0100 |
| commit | 30e9ea4193e0e2401a84ae00685a3b0d4dfcb36d (patch) | |
| tree | cc2d2b1135d8423250f6b167d6b8e359434881e1 /src/global | |
| parent | 9c4db430086bffc309387a750b45c5b208aeeb6a (diff) | |
- The GEN_DOXYGEN_DOCS option can be used for enabling
The documentation generation into a specified directory.
- doxygen program is required for generation. In case the
Doxygen is not installed, the option is ignored and
nothing is generated.
Task-number: QTBUG-141981
Change-Id: I9d05faa063c6e291302906673aa50cd7962382f1
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'src/global')
| -rw-r--r-- | src/global/configure.cmake | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/global/configure.cmake b/src/global/configure.cmake index b92de62..c8500f9 100644 --- a/src/global/configure.cmake +++ b/src/global/configure.cmake @@ -13,6 +13,7 @@ set(java_compiler_value "<not found>") set(golang_value "<not found>") set(maven_value "<not found>") set(openapi_generator_value "<not found>") +set(doxygen_value "<not found>") set(build_all_tests_value "no") set(zlib_value "no") @@ -23,6 +24,7 @@ set(golang_found FALSE) set(maven_found FALSE) set(openapi_generator_found FALSE) set(zlib_found FALSE) +set(doxygen_found FALSE) # Look for zlib, which is a required dependency for the soon-to-be generated OpenAPI Common # library. @@ -70,6 +72,13 @@ if(NOT QT_CONFIGURE_RUNNING) set(golang_found TRUE) endif() + # Look for doxygen, used to create documentation for the generated code + find_package(Doxygen) + if (DOXYGEN_EXECUTABLE) + set(doxygen_value "${DOXYGEN_EXECUTABLE}") + set(doxygen_found TRUE) + endif() + # We need to find the upstream OpenAPI generator in order to build the OpenApiCommon # library and to be able to generate any client library qt_find_package(WrapOpenAPIGenerator PROVIDED_TARGETS WrapOpenAPIGenerator::WrapOpenAPIGenerator) @@ -139,6 +148,7 @@ qt_configure_add_summary_section(NAME "Qt OpenAPI") qt_configure_add_summary_entry(ARGS "openapi_generator") qt_configure_add_summary_entry(ARGS "All test dependencies found" TYPE "message" MESSAGE "${build_all_tests_value}") +qt_configure_add_summary_entry(ARGS "doxygen" TYPE "message" MESSAGE "${doxygen_value}") qt_configure_end_summary_section() qt_configure_add_report_entry( @@ -194,3 +204,14 @@ if(NOT zlib_found) MESSAGE "${zlib_check_msg}" ) endif() + +if(NOT doxygen_found) + string(CONCAT doxygen_msg + "The doxygen was not found. The GEN_DOXYGEN_DOCS option of the qt6_add_openapi_client " + "function will be ignored. It means no doxygen documentation will be generated." + ) + qt_configure_add_report_entry( + TYPE WARNING + MESSAGE "${doxygen_msg}" + ) +endif() |