From 51edfdd212ed8be611ce6719db7ef454de5b5bcc Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Thu, 17 Oct 2019 10:24:12 +0200 Subject: [PATCH] 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 --- doc/global/config.qdocconf | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf index 0b276c400fb..16d4e5c63a0 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