From 3f5df82334b89102902051726e761180a1a72fec Mon Sep 17 00:00:00 2001
From: Alexandru Croitor <alexandru.croitor@qt.io>
Date: Wed, 22 Jan 2025 12:11:12 +0100
Subject: [PATCH] CMake: Add an option to pass --showinternal to qdoc

This adds an SHOW_INTERNAL option to qt_internal_add_docs that
passes the --showinternal option to qdoc.

The option can also be set for all calls by setting either the CMake
variable QT_QDOC_SHOW_INTERNAL or the environment variable.

Pick-to: 6.8
Fixes: QTBUG-118176
Change-Id: If72c4072e10bc5f12b0431a5f8abea6ee1e2bd69
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
(cherry picked from commit 0b7ff3d0a7be7b8df6184cde5ca33bb681790131)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
---
 cmake/QtDocsHelpers.cmake | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/cmake/QtDocsHelpers.cmake b/cmake/QtDocsHelpers.cmake
index 68de96f9833..72305848b31 100644
--- a/cmake/QtDocsHelpers.cmake
+++ b/cmake/QtDocsHelpers.cmake
@@ -41,6 +41,8 @@ endfunction()
 #
 # QDOC_GENERATE_EXTRA_ARGS - extra command-line arguments to pass to qdoc in the generate phase.
 #
+# SHOW_INTERNAL - if set, the --showinternal option is passed to qdoc.
+#
 # Additional environment variables considered:
 # QT_INSTALL_DOCS - directory path where the qt docs were expected to be installed, used for
 # linking to other built docs. If not set, defaults to the qtbase or qt5 build directory, or the
@@ -48,6 +50,9 @@ endfunction()
 #
 # QT_QDOC_EXTRA_ARGS, QT_QDOC_PREPARE_EXTRA_ARGS, QT_QDOC_GENERATE_EXTRA_ARGS - same as the options
 # but can be set as either environment or cmake variables.
+#
+# QT_QDOC_SHOW_INTERNAL - same as the option but can be set as either an environment or
+# cmake variable.
 function(qt_internal_add_docs)
     if(NOT QT_BUILD_DOCS)
         return()
@@ -72,7 +77,9 @@ function(qt_internal_add_docs)
     set(target ${ARGV0})
     set(qdoc_conf_path ${ARGV1})
 
-    set(opt_args "")
+    set(opt_args
+        SHOW_INTERNAL
+    )
     set(single_args "")
     set(multi_args
         INDEX_DIRECTORIES
@@ -95,6 +102,14 @@ function(qt_internal_add_docs)
         endforeach()
     endif()
 
+    set(show_internal_env FALSE)
+    if(DEFINED ENV{QT_QDOC_SHOW_INTERNAL})
+        set(show_internal_env $ENV{QT_QDOC_SHOW_INTERNAL})
+    endif()
+    if(arg_SHOW_INTERNAL OR QT_QDOC_SHOW_INTERNAL OR show_internal_env)
+        list(APPEND qdoc_extra_args "--showinternal")
+    endif()
+
     if(arg_QDOC_EXTRA_ARGS)
         list(APPEND qdoc_extra_args ${arg_QDOC_EXTRA_ARGS})
     endif()