path: root/doc
diff options
authorTopi Reinio <>2017-02-03 15:33:18 +0100
committerTopi Reiniƶ <>2017-02-07 08:36:00 +0000
commite4b3e47935bcab5abecc156d526836ef584f69e2 (patch)
tree29478c50bf927a7abd66cfbd2bddae4065a4e709 /doc
parent8c31f75fd31d2d83de557c0d5fb15edb384f8933 (diff)
Doc: Add a comment into config.qdocconf about generating internal docs
QDoc supports the --showinternal command line option, but it's not integrated to the build system. This commit documents an alternative way to get documentation marked as internal generated, replacing every instance of \internal with a text string '[internal]' Change-Id: Ib48ade21adf32d430e62b95c4baa64be620d7eb0 Reviewed-by: Andy Shaw <> Reviewed-by: Venugopal Shivashankar <> Reviewed-by: Martin Smith <>
Diffstat (limited to 'doc')
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf
index 0c22d70529..a18396876d 100644
--- a/doc/global/config.qdocconf
+++ b/doc/global/config.qdocconf
@@ -13,3 +13,7 @@ navigation.homepage = "Qt $QT_VER"
sourcedirs += includes $$BUILDDIR
url =
+# Uncomment the following two lines to generate documentation marked as \internal
+# alias.internal = disable
+# macro.internal.HTML = "<span style="color:red">[internal]</span>"