Doc: Prevent QDoc from auto-linking certain words

'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 <[email protected]>
CryFeiFei · Oct 19, 2019 · 51edfdd · 51edfdd
1 parent 1b6db18
commit 51edfdd
Showing 1 changed file with 6 additions and 0 deletions.
diff --git 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