Revision control
Copy as Markdown
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
project = QtProtobuf
description = Qt Protobuf Reference Documentation
version = $QT_VERSION
examplesinstallpath = protobuf
examples.fileextensions += "*.proto"
# Path to the root of qtgrpc (for automatic linking to source code)
url.sources.rootdir = ../../..
qhp.projects = QtProtobuf
moduleheader = ${project}Doc
includepaths += .
qhp.QtProtobuf.file = qtprotobuf.qhp
qhp.QtProtobuf.namespace = org.qt-project.qtprotobuf.$QT_VERSION_TAG
qhp.QtProtobuf.virtualFolder = qtprotobuf
qhp.QtProtobuf.indexTitle = Qt Protobuf
qhp.QtProtobuf.indexRoot =
qhp.QtProtobuf.subprojects = manual examples qmltypes classes \
protobufcoreclasses protobufguiclasses \
wellknowntypes
qhp.QtProtobuf.subprojects.qmltypes.title = QML Types
qhp.QtProtobuf.subprojects.qmltypes.indexTitle = Qt Protobuf QML Types
qhp.QtProtobuf.subprojects.qmltypes.selectors = qmlclass
qhp.QtProtobuf.subprojects.qmltypes.sortPages = true
qhp.QtProtobuf.subprojects.examples.title = Examples
qhp.QtProtobuf.subprojects.examples.indexTitle = Qt Protobuf Examples
qhp.QtProtobuf.subprojects.examples.selectors = example
qhp.QtProtobuf.subprojects.classes.title = C++ Classes
qhp.QtProtobuf.subprojects.classes.indexTitle = Qt Protobuf C++ Classes
qhp.QtProtobuf.subprojects.classes.selectors = class doc:headerfile module:QtProtobuf
qhp.QtProtobuf.subprojects.classes.sortPages = true
qhp.QtProtobuf.subprojects.protobufcoreclasses.title = Protobuf Qt Core Types C++ Classes
qhp.QtProtobuf.subprojects.protobufcoreclasses.indexTitle = Protobuf Qt Core Types Module
qhp.QtProtobuf.subprojects.protobufcoreclasses.selectors = module:QtProtobufQtCoreTypes
qhp.QtProtobuf.subprojects.protobufcoreclasses.sortPages = true
qhp.QtProtobuf.subprojects.protobufguiclasses.title = Protobuf Qt GUI Types C++ Classes
qhp.QtProtobuf.subprojects.protobufguiclasses.indexTitle = Protobuf Qt GUI Types Module
qhp.QtProtobuf.subprojects.protobufguiclasses.selectors = module:QtProtobufQtGuiTypes
qhp.QtProtobuf.subprojects.protobufguiclasses.sortPages = true
qhp.QtProtobuf.subprojects.wellknowntypes.title = Qt Protobuf Well-known Types C++ Classes
qhp.QtProtobuf.subprojects.wellknowntypes.indexTitle = Qt Protobuf Well-known Types C++ Classes
qhp.QtProtobuf.subprojects.wellknowntypes.selectors = module:QtProtobufWellKnownTypes
qhp.QtProtobuf.subprojects.wellknowntypes.sortPages = true
qhp.QtProtobuf.subprojects.manual.title = Qt Protobuf
qhp.QtProtobuf.subprojects.manual.indexTitle = Qt Protobuf module topics
qhp.QtProtobuf.subprojects.manual.type = manual
depends += qtdoc qtcore qtgui qtcmake qtgrpc qtwidgets qtqml qtquick qtquickcontrols
{headerdirs,sourcedirs} += .. \
../../protobufqttypes \
../../wellknown
# Exclude auto-generated Protocol Buffer wrapper headers
excludedirs += ../../wellknown/.tmp/google/protobuf
internalfilepatterns = wrappers.qpb.h
# Add additional documentation dirs
sourcedirs += ../../tools/doc
exampledirs += ../../../examples/protobuf
imagedirs += images \
../../../examples/protobuf/sensors/doc/images
navigation.landingpage = "Qt Protobuf"
navigation.cppclassespage = "Qt Protobuf C++ Classes"
navigation.qmltypespage = "Qt Protobuf QML Types"
# Auto-generate navigation linking based on "Qt Protobuf module topics":
navigation.toctitles = "Qt Protobuf module topics"
navigation.toctitles.inclusive = false
manifestmeta.highlighted.names = "QtProtobuf/Sensors"
tagfile = qtprotobuf.tags
macro.gRPC = "\\tm gRPC"
# Enforce zero documentation warnings
warninglimit = 0
# Report warnings for images without alt text
reportmissingalttextforimages = true