adding docs

Change-Id: Ie9d0fa1250a3a1a623682c40e19f815777c43852
Reviewed-by: Kranthi Kuntala <kranthi.kumar-kuntala@nokia.com>

11 files changed, 507 insertions, 2 deletions

diff --git a/alignedtimer.pro b/alignedtimer.pro
index 0cfd3aa..2151d6b 100644
--- a/alignedtimer.pro
+++ b/alignedtimer.pro
@@ -1,6 +1,7 @@
    TEMPLATE = subdirs
    CONFIG += ordered
 
+   include(doc/doc.pri)
 
    module_alignedtimer_src.subdir = src
    module_alignedtimer_src.target = module-alignedtimer-src
diff --git a/doc/compat.qdocconf b/doc/compat.qdocconf
new file mode 100755
index 0000000..11965b8
--- /dev/null
+++ b/doc/compat.qdocconf
@@ -0,0 +1,30 @@
+alias.include                   = input
+
+macro.0                         = "\\\\0"
+macro.b                         = "\\\\b"
+macro.n                         = "\\\\n"
+macro.r                         = "\\\\r"
+macro.i                         = "\\li"
+macro.i11                       = "\\li{1,1}"
+macro.i12                       = "\\li{1,2}"
+macro.i13                       = "\\li{1,3}"
+macro.i14                       = "\\li{1,4}"
+macro.i15                       = "\\li{1,5}"
+macro.i16                       = "\\li{1,6}"
+macro.i17                       = "\\li{1,7}"
+macro.i18                       = "\\li{1,8}"
+macro.i19                       = "\\li{1,9}"
+macro.i21                       = "\\li{2,1}"
+macro.i31                       = "\\li{3,1}"
+macro.i41                       = "\\li{4,1}"
+macro.i51                       = "\\li{5,1}"
+macro.i61                       = "\\li{6,1}"
+macro.i71                       = "\\li{7,1}"
+macro.i81                       = "\\li{8,1}"
+macro.i91                       = "\\li{9,1}"
+macro.img                       = "\\image"
+macro.endquote                  = "\\endquotation"
+macro.relatesto                 = "\\relates"
+
+spurious                        = "Missing comma in .*"\
+                                  "Missing pattern .*"
diff --git a/doc/doc.pri b/doc/doc.pri
new file mode 100644
index 0000000..459e9ba
--- /dev/null
+++ b/doc/doc.pri
@@ -0,0 +1,14 @@
+OTHER_FILES += \
+                $$PWD/qt5.qdocconf \
+                $$PWD/qt5-dita.qdocconf
+
+docs_target.target = docs
+docs_target.commands = qdoc3 $$PWD/qt5.qdocconf
+
+ditadocs_target.target = ditadocs
+ditadocs_target.commands = qdoc3 $$PWD/qt5-dita.qdocconf
+
+QMAKE_EXTRA_TARGETS = docs_target ditadocs_target
+QMAKE_CLEAN += \
+               "-r $$PWD/html" \
+               "-r $$PWD/ditaxml"
diff --git a/doc/macros.qdocconf b/doc/macros.qdocconf
new file mode 100755
index 0000000..dd46841
--- /dev/null
+++ b/doc/macros.qdocconf
@@ -0,0 +1,43 @@
+macro.aacute.HTML       = "á"
+macro.Aring.HTML        = "Å"
+macro.aring.HTML        = "å"
+macro.Auml.HTML         = "Ä"
+macro.author            = "\\b{Author:}"
+macro.br.HTML           = "<br />"
+macro.BR.HTML           = "<br />"
+macro.copyright.HTML    = "&copy;"
+macro.eacute.HTML       = "&eacute;"
+macro.gui               = "\\b"
+macro.hr.HTML           = "<hr />"
+macro.iacute.HTML       = "&iacute;"
+macro.key               = "\\b"
+macro.menu              = "\\b"
+macro.note              = "\\b{Note:}"
+macro.oslash.HTML       = "&oslash;"
+macro.ouml.HTML         = "&ouml;"
+macro.QA                = "Qt Assistant"
+macro.QC                = "Creator"
+macro.QD                = "Qt Designer"
+macro.QL                = "Qt Linguist"
+macro.QMLD              = "Qt Quick Designer"
+macro.QQV               = "Qt QML Viewer"
+macro.QSDK              = "Qt SDK"
+#macro.qtcversion        = $QTC_VERSION
+macro.qtcversion        = "0.0"
+macro.param             = "\\e"
+macro.raisedaster.HTML  = "<sup>*</sup>"
+macro.rarrow.HTML       = "&rarr;"
+macro.reg.HTML          = "<sup>&reg;</sup>"
+macro.return            = "Returns"
+macro.starslash         = "\\c{*/}"
+macro.begincomment      = "\\c{/*}"
+macro.endcomment        = "\\c{*/}"
+macro.uuml.HTML         = "&uuml;"
+macro.mdash.HTML        = "&mdash;"
+macro.pi.HTML         = "&Pi;"
+
+macro.beginfloatleft.HTML   = "<div style=\"float: left; margin-right: 2em\">"
+macro.beginfloatright.HTML  = "<div style=\"float: right; margin-left: 2em\">"
+macro.endfloat.HTML         = "</div>"
+macro.clearfloat.HTML       = "<br style=\"clear: both\" />"
+macro.emptyspan.HTML        = "<span></span>"
diff --git a/doc/qt-cpp-ignore.qdocconf b/doc/qt-cpp-ignore.qdocconf
new file mode 100755
index 0000000..42b04ca
--- /dev/null
+++ b/doc/qt-cpp-ignore.qdocconf
@@ -0,0 +1,100 @@
+Cpp.ignoretokens        = QAXFACTORY_EXPORT \
+                          QDESIGNER_COMPONENTS_LIBRARY \
+                          QDESIGNER_EXTENSION_LIBRARY \
+                          QDESIGNER_SDK_LIBRARY \
+                          QDESIGNER_SHARED_LIBRARY \
+                          QDESIGNER_UILIB_LIBRARY \
+                          QM_EXPORT_CANVAS \
+                          QM_EXPORT_DNS \
+                          QM_EXPORT_DOM \
+                          QM_EXPORT_FTP \
+                          QM_EXPORT_HTTP \
+                          QM_EXPORT_ICONVIEW \
+                          QM_EXPORT_NETWORK \
+                          QM_EXPORT_OPENGL \
+                          QM_EXPORT_OPENVG \
+                          QM_EXPORT_SQL \
+                          QM_EXPORT_TABLE \
+                          QM_EXPORT_WORKSPACE \
+                          QM_EXPORT_XML \
+                          QT_ASCII_CAST_WARN \
+                          QT_ASCII_CAST_WARN_CONSTRUCTOR \
+                          QT_BEGIN_HEADER \
+                          QT_DESIGNER_STATIC \
+                          QT_END_HEADER \
+                          QT_FASTCALL \
+                          QT_WIDGET_PLUGIN_EXPORT \
+                          Q_COMPAT_EXPORT \
+                          Q_CORE_EXPORT \
+                          Q_CORE_EXPORT_INLINE \
+                          Q_EXPLICIT \
+                          Q_EXPORT \
+                          Q_EXPORT_CODECS_CN \
+                          Q_EXPORT_CODECS_JP \
+                          Q_EXPORT_CODECS_KR \
+                          Q_EXPORT_PLUGIN \
+                          Q_GFX_INLINE \
+                          Q_AUTOTEST_EXPORT \
+                          Q_GUI_EXPORT \
+                          Q_GUI_EXPORT_INLINE \
+                          Q_GUI_EXPORT_STYLE_CDE \
+                          Q_GUI_EXPORT_STYLE_COMPACT \
+                          Q_GUI_EXPORT_STYLE_MAC \
+                          Q_GUI_EXPORT_STYLE_MOTIF \
+                          Q_GUI_EXPORT_STYLE_MOTIFPLUS \
+                          Q_GUI_EXPORT_STYLE_PLATINUM \
+                          Q_GUI_EXPORT_STYLE_POCKETPC \
+                          Q_GUI_EXPORT_STYLE_SGI \
+                          Q_GUI_EXPORT_STYLE_WINDOWS \
+                          Q_GUI_EXPORT_STYLE_WINDOWSXP \
+                          QHELP_EXPORT \
+                          Q_INLINE_TEMPLATE \
+                          Q_INTERNAL_WIN_NO_THROW \
+                          Q_LOCATION_EXPORT \
+                          Q_NETWORK_EXPORT \
+                          Q_OPENGL_EXPORT \
+                          Q_OPENVG_EXPORT \
+                          Q_OUTOFLINE_TEMPLATE \
+                          Q_SQL_EXPORT \
+                          Q_SVG_EXPORT \
+                          Q_SCRIPT_EXPORT \
+                          Q_SCRIPTTOOLS_EXPORT \
+                          Q_TESTLIB_EXPORT \
+                          Q_TYPENAME \
+                          Q_XML_EXPORT \
+                          Q_XMLSTREAM_EXPORT \
+                          Q_XMLPATTERNS_EXPORT \
+                          QDBUS_EXPORT \
+                          Q_DBUS_EXPORT \
+                          QT_BEGIN_NAMESPACE \
+                          QT_BEGIN_INCLUDE_NAMESPACE \
+                          QT_END_NAMESPACE \
+                          QT_END_INCLUDE_NAMESPACE \
+                          PHONON_EXPORT \
+                          Q_DECLARATIVE_EXPORT \
+                          Q_GADGET \
+                          QWEBKIT_EXPORT \
+                          Q_INVOKABLE \
+                          Q_DECL_CONSTEXPR
+Cpp.ignoredirectives    = Q_DECLARE_HANDLE\
+                          Q_DECLARE_INTERFACE \
+                          Q_DECLARE_METATYPE \
+                          Q_DECLARE_OPERATORS_FOR_FLAGS \
+                          Q_DECLARE_PRIVATE \
+                          Q_DECLARE_PUBLIC \
+                          Q_DECLARE_SHARED \
+                          Q_DECLARE_TR_FUNCTIONS \
+                          Q_DECLARE_TYPEINFO \
+                          Q_DISABLE_COPY \
+                          QT_FORWARD_DECLARE_CLASS \
+                          Q_DUMMY_COMPARISON_OPERATOR \
+                          Q_ENUMS \
+                          Q_FLAGS \
+                          Q_INTERFACES \
+                          __attribute__ \
+                          K_DECLARE_PRIVATE \
+                          PHONON_OBJECT \
+                          PHONON_HEIR \
+                          Q_PRIVATE_PROPERTY \
+                          Q_DECLARE_PRIVATE_D \
+                          Q_CLASSINFO
diff --git a/doc/qt-defines.qdocconf b/doc/qt-defines.qdocconf
new file mode 100755
index 0000000..5a1c975
--- /dev/null
+++ b/doc/qt-defines.qdocconf
@@ -0,0 +1,18 @@
+defines                 = Q_QDOC \
+                          QT_.*_SUPPORT \
+                          QT_.*_LIB \
+                          QT_COMPAT \
+                          QT_KEYPAD_NAVIGATION \
+                          QT_NO_EGL \
+                          QT3_SUPPORT \
+                          Q_WS_.* \
+                          Q_OS_.* \
+                          Q_BYTE_ORDER \
+                          QT_DEPRECATED \
+                          Q_NO_USING_KEYWORD \
+                          __cplusplus\
+                          Q_COMPILER_INITIALIZER_LISTS
+
+versionsym              = QT_VERSION_STR
+
+codeindent              = 1
diff --git a/doc/qt5-dita.qdocconf b/doc/qt5-dita.qdocconf
new file mode 100644
index 0000000..758269f
--- /dev/null
+++ b/doc/qt5-dita.qdocconf
@@ -0,0 +1,32 @@
+# Name of the project.
+project = QAlignedTimer
+
+# Directories in which to search for files to document and images.
+# By default set to the root directory of the project for sources
+# and headers and qdoc will therefore generate output for each file.
+# Images should be placed in <rootdir>/dic/images and examples in
+# <rootdir>/examples.
+# Paths are relative to the  location of this file.
+headerdirs  += ..
+
+sourcedirs  += .. \
+               ../doc/src
+
+exampledirs += ../.. \
+               ../doc/src \
+               ../examples
+
+imagedirs   += ../doc/src/images \
+               ../examples
+
+excludedirs +=
+
+
+
+#Do not change the variables after this line unless you know what you are doing.
+
+outputdir = ditaxml
+outputformats = DITAXML
+
+sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
+headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
diff --git a/doc/qt5.qdocconf b/doc/qt5.qdocconf
new file mode 100644
index 0000000..6d1c6bf
--- /dev/null
+++ b/doc/qt5.qdocconf
@@ -0,0 +1,84 @@
+# Name of the project.
+project = QAlignedTimer
+
+include(macros.qdocconf)
+include(compat.qdocconf)
+include(qt-cpp-ignore.qdocconf)
+include(qt-defines.qdocconf)
+
+# Directories in which to search for files to document and images.
+# By default set to the root directory of the project for sources
+# and headers and qdoc will therefore generate output for each file.
+# Images should be placed in <rootdir>/dic/images and examples in
+# <rootdir>/examples.
+# Paths are relative to the  location of this file.
+headerdirs  += ..
+
+sourcedirs  += .. \
+               ../doc/src
+
+exampledirs += .. \
+               ../doc/src \
+               ../examples
+
+imagedirs   += ../doc/src/images \
+               ../examples
+
+excludedirs +=
+
+# 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 = QAlignedTimer
+
+# Sets the name of the output qhp file.
+qhp.QAlignedTimer.file = QAlignedTimer.qhp
+
+# Namespace for the output file. This namespace is used to distinguish between
+# different documentation files in Creator/Assistant. Normal format for MP
+# projects should be: com.nokia.mp.<projectname>.version with version being
+# a number containing a major, minor and revision element. E.g. version 1.0
+# becomes 100.
+qhp.QAlignedTimer.namespace = com.nokia.mp.QAlignedTimer.100
+
+# Title for the package, will be the main title for the package in
+# Assistant/Creator.
+qhp.QAlignedTimer.indexTitle = QAlignedTimer Documentation
+
+# Extra files to add to the output which are not linked to from anywhere
+# using a qdoc \l command.
+qhp.QAlignedTimer.extraFiles = style/style.css \
+                                     index.html
+
+# Only update the name of the project for the next variables.
+qhp.QAlignedTimer.virtualFolder  = qdoc
+qhp.QAlignedTimer.subprojects = classes
+qhp.QAlignedTimer.subprojects.classes.title = Classes
+qhp.QAlignedTimer.subprojects.classes.selectors = class fake:headerfile
+qhp.QAlignedTimer.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<body>\n"
+
+HTML.footer = "<div class=\"footer\">Copyright (C) 2012 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>\n"
diff --git a/doc/src/QAlignedtimer/QAlignedtimer.qdoc b/doc/src/QAlignedtimer/QAlignedtimer.qdoc
new file mode 100644
index 0000000..9e24f06
--- /dev/null
+++ b/doc/src/QAlignedtimer/QAlignedtimer.qdoc
@@ -0,0 +1,48 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** 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.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page QtAlignedTimer.html
+
+    \title QtAlignedTimer Module
+    \brief The QAlignedTimer class provides a service for applications to synchronize their activity.
+
+    \tableofcontents
+
+    \ingroup technology-apis
+    QtAlignedTimer is a fuzzy timer that allows applications that must do periodic activity like
+    after being in sleep mode a certain period, to synchronize their activities in the same window of time.
+
+    For example send network "alive" messages at the same time (i.e. turn the wireless radio on at the same time).
+
+    The service is not only for network-aware applications, it is for use by any applications
+    that need to periodic wake-ups.
+
+    \section1 C++ Classes
+    \generatelist classes
+
+*/
diff --git a/doc/style/style.css b/doc/style/style.css
new file mode 100644
index 0000000..df84049
--- /dev/null
+++ b/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/alignedtimer/qalignedtimer.cpp b/src/alignedtimer/qalignedtimer.cpp
index 5c644f6..7b12180 100644
--- a/src/alignedtimer/qalignedtimer.cpp
+++ b/src/alignedtimer/qalignedtimer.cpp
@@ -52,7 +52,6 @@ Q_GLOBAL_STATIC(QAlignedTimerPrivate, alignedTimerPrivate)
 
 /*!
     \class QAlignedTimer
-    \ingroup events
     \brief The QAlignedTimer class provides a service for applications to synchronize their activity.
 
     QAlignedTimer is a fuzzy timer that allows applications that must do periodic activity like
@@ -65,7 +64,6 @@ Q_GLOBAL_STATIC(QAlignedTimerPrivate, alignedTimerPrivate)
 
     The recommended use case is when app uses single-shot timer only: set mintime 0 for the first call
     'to jump to the train' and mintime > 0 after 1st wakeup.
-    \sa QBasicTimer, QTimer, QTimerEvent, QObject::timerEvent(), Timers,
 */
 
 /*!