qt5base-lts/doc/global/config.qdocconf
Topi Reinio 51edfdd212 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 <martin.smith@qt.io>
2019-10-19 18:36:13 +02:00

27 lines
786 B
Plaintext

#Include this file to inherit configuration related to Qt Project based modules.
dita.metadata.default.author = Qt Project
dita.metadata.default.permissions = all
dita.metadata.default.publisher = Qt Project
dita.metadata.default.copyryear = 2019
dita.metadata.default.copyrholder = The Qt Company Ltd
dita.metadata.default.audience = programmer
#Set the main Qt index.html
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
# Uncomment the following two lines to generate documentation marked as \internal
# alias.internal = disable
# macro.internal.HTML = "<span style="color:red">[internal]</span>"