Refactor the documentation management for the source

* Other submodules use qtsubmodule.qdocconf instead of submodule.qdocconf

* They also use the QMAKE_DOCS variable to set that to the qtsubmodule.qdocconf

* They do not have .pri files for the doc folder

* They do not use the QT5DOC variable with "indexes" either. It should have been
indices with proper English, anyway.

* This also eliminates a warning about the "docs" target duplication

The docs is not fully complete yet, but the work is in progress. This is the
first step.

Change-Id: If33073d367fa7971fb57169d498f005766c166a9
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>

1 files changed, 77 insertions, 0 deletions

diff --git a/src/serialport/doc/qtserialport.qdocconf b/src/serialport/doc/qtserialport.qdocconf
new file mode 100644
index 00000000..36e0820c
--- /dev/null
+++ b/src/serialport/doc/qtserialport.qdocconf
@@ -0,0 +1,77 @@
+project     = QtSerialPort
+description = Qt Serial Port Documentation
+
+exampledirs = ../../../examples ..
+headerdirs  = ./src ../src
+imagedirs   = ./src/images
+sourcedirs  = ./src ../src
+
+Cpp.ignoretokens = \
+    Q_SERIALPORT_EXPORT
+
+Cpp.ignoredirectives = \
+    Q_DECLARE_OPERATORS_FOR_FLAGS \
+    Q_DECLARE_PRIVATE \
+    Q_DECLARE_PUBLIC \
+    Q_ENUMS \
+    Q_DISABLE_COPY
+
+# 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.
+
+# 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
+
+# Sets the name of the output qhp file.
+qhp.QtSerialPort.file = QtSerialPort.qhp
+
+# 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
+
+# Title for the package, will be the main title for the package in
+# Assistant/Creator.
+qhp.QtSerialPort.indexTitle = Qt Serial Port Reference Documentation
+
+# 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
+
+# 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"