diff options
-rw-r--r-- | src/serialport/doc/images/blockingmaster-example.png (renamed from src/serialport/doc/src/images/blockingmaster-example.png) | bin | 4656 -> 4656 bytes | |||
-rw-r--r-- | src/serialport/doc/images/blockingslave-example.png (renamed from src/serialport/doc/src/images/blockingslave-example.png) | bin | 4784 -> 4784 bytes | |||
-rw-r--r-- | src/serialport/doc/images/cenumerator-example.png (renamed from src/serialport/doc/src/images/cenumerator-example.png) | bin | 3532 -> 3532 bytes | |||
-rw-r--r-- | src/serialport/doc/images/enumerator-example.png (renamed from src/serialport/doc/src/images/enumerator-example.png) | bin | 18510 -> 18510 bytes | |||
-rw-r--r-- | src/serialport/doc/images/terminal-example.png (renamed from src/serialport/doc/src/images/terminal-example.png) | bin | 10918 -> 10918 bytes | |||
-rw-r--r-- | src/serialport/doc/qtserialport.qdocconf | 97 |
6 files changed, 30 insertions, 67 deletions
diff --git a/src/serialport/doc/src/images/blockingmaster-example.png b/src/serialport/doc/images/blockingmaster-example.png Binary files differindex 44aa5ec..44aa5ec 100644 --- a/src/serialport/doc/src/images/blockingmaster-example.png +++ b/src/serialport/doc/images/blockingmaster-example.png diff --git a/src/serialport/doc/src/images/blockingslave-example.png b/src/serialport/doc/images/blockingslave-example.png Binary files differindex 44aa393..44aa393 100644 --- a/src/serialport/doc/src/images/blockingslave-example.png +++ b/src/serialport/doc/images/blockingslave-example.png diff --git a/src/serialport/doc/src/images/cenumerator-example.png b/src/serialport/doc/images/cenumerator-example.png Binary files differindex 03792e7..03792e7 100644 --- a/src/serialport/doc/src/images/cenumerator-example.png +++ b/src/serialport/doc/images/cenumerator-example.png diff --git a/src/serialport/doc/src/images/enumerator-example.png b/src/serialport/doc/images/enumerator-example.png Binary files differindex c4add83..c4add83 100644 --- a/src/serialport/doc/src/images/enumerator-example.png +++ b/src/serialport/doc/images/enumerator-example.png diff --git a/src/serialport/doc/src/images/terminal-example.png b/src/serialport/doc/images/terminal-example.png Binary files differindex 28aa366..28aa366 100644 --- a/src/serialport/doc/src/images/terminal-example.png +++ b/src/serialport/doc/images/terminal-example.png diff --git a/src/serialport/doc/qtserialport.qdocconf b/src/serialport/doc/qtserialport.qdocconf index 36e0820..9d545bc 100644 --- a/src/serialport/doc/qtserialport.qdocconf +++ b/src/serialport/doc/qtserialport.qdocconf @@ -1,77 +1,40 @@ -project = QtSerialPort -description = Qt Serial Port Documentation +include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -exampledirs = ../../../examples .. -headerdirs = ./src ../src -imagedirs = ./src/images -sourcedirs = ./src ../src +project = QtSerialPort +description = Qt Serial Port Reference Documentation +url = http://qt-project.org/doc/qt-$QT_VER/qtserialport +version = $QT_VERSION -Cpp.ignoretokens = \ - Q_SERIALPORT_EXPORT +qhp.projects = QtSerialPort -Cpp.ignoredirectives = \ - Q_DECLARE_OPERATORS_FOR_FLAGS \ - Q_DECLARE_PRIVATE \ - Q_DECLARE_PUBLIC \ - Q_ENUMS \ - Q_DISABLE_COPY +qhp.QtSerialPort.file = qtserialport.qhp +qhp.QtSerialPort.namespace = org.qt-project.qtserialport.$QT_VERSION_TAG +qhp.QtSerialPort.virtualFolder = qtserialport +qhp.QtSerialPort.indexTitle = Qt Serial Port Reference Documentation +qhp.QtSerialPort.indexRoot = -# The following parameters are for creating a qhp file, the qhelpgenerator -# program can convert the qhp file into a qch file which can be opened in -# Qt Assistant and/or Qt Creator. +qhp.QtSerialPort.filterAttributes = qtserialport $QT_VERSION qtrefdoc +qhp.QtSerialPort.customFilters.Qt.name = QtSerialPort $QT_VERSION +qhp.QtSerialPort.customFilters.Qt.filterAttributes = qtserialport $QT_VERSION -# Defines the name of the project. You cannot use operators (+, =, -) in -# the name. Properties for this project are set using a qhp.<projectname>.property -# format. -qhp.projects = QtSerialPort +qhp.QtSerialPort.subprojects = overviews classes examples -# Sets the name of the output qhp file. -qhp.QtSerialPort.file = QtSerialPort.qhp +qhp.QtSerialPort.subprojects.overviews.title = Overview +qhp.QtSerialPort.subprojects.overviews.indexTitle = Qt Serial Port +qhp.QtSerialPort.subprojects.overviews.selectors = fake:page,group,module -# Namespace for the output file. This namespace is used to distinguish between -# different documentation files in Creator/Assistant. The namespace ends with -# a version being a number containing a major, minor and revision element. -# E.g. version 5.1 becomes 510. -qhp.QtSerialPort.namespace = com.qt-project.qtserialport.510 +qhp.QtSerialPort.subprojects.overviews.title = C++ Classes +qhp.QtSerialPort.subprojects.overviews.indexTitle = Qt Serial Port C++ Classes +qhp.QtSerialPort.subprojects.overviews.selectors = class fake:headerfile -# Title for the package, will be the main title for the package in -# Assistant/Creator. -qhp.QtSerialPort.indexTitle = Qt Serial Port Reference Documentation +qhp.QtSerialPort.subprojects.examples.title = Examples +qhp.QtSerialPort.subprojects.examples.indexTitle = Qt Serial Port Examples +qhp.QtSerialPort.subprojects.examples.selectors = fake:example -# Extra files to add to the output which are not linked to from anywhere -# using a qdoc \l command. -qhp.QtSerialPort.extraFiles = style/style.css \ - index.html +headerdirs += .. +sourcedirs += .. +exampledirs += ../../../examples +imagedirs += images -# Only update the name of the project for the next variables. -qhp.QtSerialPort.virtualFolder = qdoc -qhp.QtSerialPort.subprojects = classes -qhp.QtSerialPort.subprojects.classes.title = Classes -qhp.QtSerialPort.subprojects.classes.selectors = class fake:headerfile -qhp.QtSerialPort.subprojects.classes.sortPages = true - - -# Do NOT change the variables after this line unless you know what you are doing. - -outputdir = html -outputformats = HTML - -examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml" -examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng" -headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" -sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" - -HTML.nobreadcrumbs = "true" - -HTML.templatedir = . -HTML.stylesheets = style/style.css - -HTML.headerstyles = " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\" />\n" -HTML.endheader = "</head>\n" - -HTML.postheader = \ - " <div class=\"header\">\n" \ - " <div id=\"nav-logo\">\n" \ - " <a href=\"index.html\">Qt Serial Port Reference</a>" \ - " </div>\n" \ - " </div>\n" +depends += qtcore qtdoc |