Move the library and example documentations to the right places

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

12 files changed, 488 insertions, 0 deletions

diff --git a/src/serialport/doc/doc.pri b/src/serialport/doc/doc.pri
new file mode 100644
index 0000000..a2097b7
--- /dev/null
+++ b/src/serialport/doc/doc.pri
@@ -0,0 +1,7 @@
+OTHER_FILES += $$PWD/serialport.qdocconf
+
+docs_target.target = docs
+docs_target.commands = qdoc3 $$PWD/serialport.qdocconf
+
+QMAKE_EXTRA_TARGETS = docs_target
+QMAKE_CLEAN += "-r $$PWD/html"
diff --git a/src/serialport/doc/serialport.qdocconf b/src/serialport/doc/serialport.qdocconf
new file mode 100644
index 0000000..5c032d9
--- /dev/null
+++ b/src/serialport/doc/serialport.qdocconf
@@ -0,0 +1,83 @@
+project     = SerialPort
+description = SerialPort Documentation
+
+exampledirs = ../../../examples ..
+headerdirs  = ./src ../src
+imagedirs   = ./src/images
+sourcedirs  = ./src ../src
+
+# The index file contains links to the Qt 5 documentation.
+# Point to the any .index file to cross link to other projects
+indexes = $QT5DOC/doc/html/qt.index
+
+Cpp.ignoretokens = \
+    QT_BEGIN_NAMESPACE_SERIALPORT \
+    QT_END_NAMESPACE_SERIALPORT \
+    Q_ADDON_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 = SerialPort
+
+# Sets the name of the output qhp file.
+qhp.SerialPort.file = SerialPort.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 1.0 becomes 100.
+qhp.SerialPort.namespace = com.nokia.SerialPort.100
+
+# Title for the package, will be the main title for the package in
+# Assistant/Creator.
+qhp.SerialPort.indexTitle = SerialPort Reference Documentation
+
+# Extra files to add to the output which are not linked to from anywhere
+# using a qdoc \l command.
+qhp.SerialPort.extraFiles = style/style.css \
+                            index.html
+
+# Only update the name of the project for the next variables.
+qhp.SerialPort.virtualFolder = qdoc
+qhp.SerialPort.subprojects = classes
+qhp.SerialPort.subprojects.classes.title = Classes
+qhp.SerialPort.subprojects.classes.selectors = class fake:headerfile
+qhp.SerialPort.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\">SerialPort Reference</a>" \
+  "   </div>\n" \
+  " </div>\n"
diff --git a/src/serialport/doc/src/build.qdoc b/src/serialport/doc/src/build.qdoc
new file mode 100644
index 0000000..127dc53
--- /dev/null
+++ b/src/serialport/doc/src/build.qdoc
@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** Copyright (C) 2011-2012 Denis Shienkov <scapig2@yandex.ru>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \module QtAddonSerialPort
+    \title Building and usage
+    \page build.html
+    \previouspage Get source
+    \contentspage {Building and usage} {Contents}
+    \nextpage Examples
+
+    \section1 Bla-Bla1
+
+    Bla-Bla-Bla
+
+    \section1 Bla-Bla2
+
+    Bla-Bla-Bla
+*/
diff --git a/src/serialport/doc/src/getsrc.qdoc b/src/serialport/doc/src/getsrc.qdoc
new file mode 100644
index 0000000..8fcab95
--- /dev/null
+++ b/src/serialport/doc/src/getsrc.qdoc
@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** Copyright (C) 2011-2012 Denis Shienkov <scapig2@yandex.ru>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \module QtAddonSerialPort
+    \title Get source
+    \page getsrc.html
+    \previouspage Introduction
+    \contentspage {Get source} {Contents}
+    \nextpage Building and usage
+
+    \section1 For users
+
+    Bla-Bla-Bla
+
+    \section1 For developers
+
+    Bla-Bla-Bla
+*/
diff --git a/src/serialport/doc/src/images/cenumerator-example.png b/src/serialport/doc/src/images/cenumerator-example.png
new file mode 100644
index 0000000..03792e7
--- /dev/null
+++ b/src/serialport/doc/src/images/cenumerator-example.png
diff --git a/src/serialport/doc/src/images/enumerator-example.png b/src/serialport/doc/src/images/enumerator-example.png
new file mode 100644
index 0000000..c4add83
--- /dev/null
+++ b/src/serialport/doc/src/images/enumerator-example.png
diff --git a/src/serialport/doc/src/images/terminal-example.png b/src/serialport/doc/src/images/terminal-example.png
new file mode 100644
index 0000000..28aa366
--- /dev/null
+++ b/src/serialport/doc/src/images/terminal-example.png
diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc
new file mode 100644
index 0000000..e290804
--- /dev/null
+++ b/src/serialport/doc/src/index.qdoc
@@ -0,0 +1,62 @@
+/****************************************************************************
+**
+** Copyright (C) 2011-2012 Denis Shienkov <scapig2@yandex.ru>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \module QtAddonSerialPort
+    \title Qt Addon SerialPort Reference Documentation
+    \page index.html
+
+    \brief The QtAddonSerialPort module provides classes to make serial programming
+    easier and portable.
+
+    To include the definitions of the module's classes, use the
+    following directive:
+
+    \code
+    #include <QtAddOnSerialPort/QtAddOnSerialPort>
+    \endcode
+
+    To link against the module, add this line to your \l qmake \c
+    .pro file:
+
+    \code
+    QT += serialport
+    \endcode
+
+    Table of contents:
+
+    \list
+    \o \l {Introduction}
+    \o \l {Get source}
+    \o \l {Building and usage}
+    \o \l {Examples}
+    \endlist
+
+    \section1 C++ Classes
+
+    \generatelist annotatedclasses
+*/
diff --git a/src/serialport/doc/src/intro.qdoc b/src/serialport/doc/src/intro.qdoc
new file mode 100644
index 0000000..b8d7145
--- /dev/null
+++ b/src/serialport/doc/src/intro.qdoc
@@ -0,0 +1,80 @@
+/****************************************************************************
+**
+** Copyright (C) 2011-2012 Denis Shienkov <scapig2@yandex.ru>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \module QtAddonSerialPort
+    \title Introduction
+    \page intro.html
+    \contentspage {Introduction} {Contents}
+    \nextpage Get source
+
+    \section1 History
+
+    QtSerialPort originated from the third-party library
+    \l{http://gitorious.org/qserialdevice/qserialdevice/trees/2.0}{QSerialDevice 2.0}.
+
+    \section1 Overviews
+
+    Bla-bla
+
+    \section1 Supported platforms
+
+    The goal is to implement support for multiple platforms, the current state
+    of support provided in the table below:
+
+    \table
+    \header
+        \o Platform
+        \o Support state
+        \o Notes
+    \row
+        \o Windows x86/x64 NT based (2K, XP, Vista, 7, 8)
+        \o Full support.
+        \o Support expected for Windows 8, but has not yet been tested.
+    \row
+        \o Windows CE
+        \o Partially support.
+        \o Tested only with platforms 5 and 6 by using the emulator.
+    \row
+        \o Symbian
+        \o Partially support.
+        \o The implementation is not complete and further support in doubt.
+    \row
+        \o Gnu/Linux
+        \o Full support.
+        \o
+    \row
+        \o Mac OSX
+        \o Full support.
+        \o
+    \row
+        \o Other *nix
+        \o Full support.
+        \o All POSIX-compatible.
+    \endtable
+
+*/
diff --git a/src/serialport/doc/src/namespace.qdoc b/src/serialport/doc/src/namespace.qdoc
new file mode 100644
index 0000000..2dfaeb6
--- /dev/null
+++ b/src/serialport/doc/src/namespace.qdoc
@@ -0,0 +1,32 @@
+/****************************************************************************
+**
+** Copyright (C) 2011-2012 Denis Shienkov <scapig2@yandex.ru>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \namespace SerialPort
+    \brief The SerialPort namespace contains miscellaneous identifiers
+    used throughout the SerialPort library.
+*/
diff --git a/src/serialport/doc/style/style.css b/src/serialport/doc/style/style.css
new file mode 100644
index 0000000..df84049
--- /dev/null
+++ b/src/serialport/doc/style/style.css
@@ -0,0 +1,137 @@
+a:link, a:visited {
+    color: #00732F;
+    text-decoration: none;
+    font-weight: bold;
+}
+
+body {
+    font: normal 400 14px/1.2 Arial;
+    margin-top: 85px;
+}
+
+h1 {
+    margin: 0;
+}
+
+h2 {
+    font: 500 20px/1.2 Arial;
+}
+
+h3.fn, span.fn {
+    -moz-border-radius: 7px 7px 7px 7px;
+    -webkit-border-radius: 7px 7px 7px 7px;
+    border-radius: 7px 7px 7px 7px;
+    background-color: #F6F6F6;
+    border-width: 1px;
+    border-style: solid;
+    border-color: #E6E6E6;
+    word-spacing: 3px;
+    padding: 3px 5px;
+}
+
+table, pre {
+    -moz-border-radius: 7px 7px 7px 7px;
+    -webkit-border-radius: 7px 7px 7px 7px;
+    border-radius: 7px 7px 7px 7px;
+    background-color: #F6F6F6;
+    border: 1px solid #E6E6E6;
+    border-collapse: separate;
+    font-size: 12px;
+    line-height: 1.2;
+    margin-bottom: 25px;
+    margin-left: 15px;
+}
+
+table td {
+    padding: 3px 15px 3px 20px;
+}
+
+table tr.even {
+    background-color: white;
+    color: #66666E;
+}
+
+table tr.odd {
+    background-color: #F6F6F6;
+    color: #66666E;
+}
+
+li {
+    margin-bottom: 10px;
+    padding-left: 12px;
+}
+
+.cpp {
+    display: block;
+    margin: 10;
+    overflow: hidden;
+    overflow-x: hidden;
+    overflow-y: hidden;
+    padding: 20px 0 20px 0;
+}
+
+.footer {
+    margin-top: 50px;
+}
+
+.memItemLeft {
+    padding-right: 3px;
+}
+
+.memItemRight {
+    padding: 3px 15px 3px 0;
+}
+
+.qml {
+    display: block;
+    margin: 10;
+    overflow: hidden;
+    overflow-x: hidden;
+    overflow-y: hidden;
+    padding: 20px 0 20px 0;
+}
+
+.qmldefault {
+    padding-left: 5px;
+    float: right;
+    color: red;
+}
+
+.qmlreadonly {
+    padding-left: 5px;
+    float: right;
+    color: #254117;
+}
+
+.rightAlign {
+    padding: 3px 5px 3px 10px;
+    text-align: right;
+}
+
+.title {
+    background-color: white;
+    color: #44A51C;
+    font-family: Verdana;
+    font-size: 35px;
+    font-weight: normal;
+    left: 0;
+    padding-bottom: 5px;
+    padding-left: 16px;
+    padding-top: 20px;
+    position: absolute;
+    right: 0;
+    top: 0;
+}
+
+.toc {
+    float: right;
+    -moz-border-radius: 7px 7px 7px 7px;
+    -webkit-border-radius: 7px 7px 7px 7px;
+    border-radius: 7px 7px 7px 7px;
+    background-color: #F6F6F6;
+    border: 1px solid #DDD;
+    margin: 0 20px 10px 10px;
+    padding: 20px 15px 20px 20px;
+    height: auto;
+    width: 200px;
+}
diff --git a/src/serialport/serialport.pro b/src/serialport/serialport.pro
index 0d1e13b..52d480c 100644
--- a/src/serialport/serialport.pro
+++ b/src/serialport/serialport.pro
@@ -2,6 +2,7 @@ QT = core
 DEFINES += QT_SERIALPORT_LIB
 VERSION = 0.1.0
 
+include($$PWD/doc/doc.pri)
 include($$PWD/serialport-lib.pri)
 
 greaterThan(QT_MAJOR_VERSION, 4) {