summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-10-17 10:24:12 +0200
committerTopi Reinio <topi.reinio@qt.io>2019-10-19 18:36:13 +0200
commit51edfdd212ed8be611ce6719db7ef454de5b5bcc (patch)
treec8a115003488f7b0ec1af570f550d6c6364ab874
parent1b6db1849477be30ef0ca52c288d358b911ea1e4 (diff)
Doc: Prevent QDoc from auto-linking certain wordsv5.14.0-beta2
'macOS' appears in the documentation frequently, and because it resembles a variable/property name, QDoc links each occurrence of it. 'WebChannel' appears as part of a module name, but it's also a QML type - auto-linking each word to QML documentation is confusing. Likewise, there's no need to link 'OpenGL' each time. Explicit links such as \l [QML] WebChannel continue to work. Task-number: QTBUG-79135 Change-Id: I76cc84b0076255e260aa88c244102702a48f35a6 Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r--doc/global/config.qdocconf6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf
index 0b276c400f..16d4e5c63a 100644
--- a/doc/global/config.qdocconf
+++ b/doc/global/config.qdocconf
@@ -11,6 +11,12 @@ dita.metadata.default.audience = programmer
navigation.homepage = index.html
navigation.hometitle = "Qt $QT_VER"
+#Words to ignore for auto-linking
+ignorewords += \
+ macOS \
+ WebChannel \
+ OpenGL
+
sourcedirs += includes $$BUILDDIR
url = http://doc.qt.io/qt-5