summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2014-03-25 13:44:14 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-26 14:22:53 +0100
commitdca0f344a56494274f0aed957279cab92d438fb2 (patch)
treec802e0decaca8627a1689afcf8d61705bbbf0c53 /doc
parent25626c184f9a8432d631fef2cc09841d386c7f6f (diff)
downloadqtenginio-dca0f344a56494274f0aed957279cab92d438fb2.tar.gz
Doc: Fix a number of documentation issues
This change fixes a number of documentation issues: - Rename index.html landing page (collides with Qt docs) - Fix navigation - Create Enginio QML module page to get correct documentation for import statement, fix linking for QML types - Fix subtopics for generated QCH files - Remove unused pages and files - Update documentation namespaces and URLs - Other minor fixes Change-Id: I0a87ab6d0be7df53199e54f4ecd9f84ef30d8622 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/enginio_global.qdocconf2
-rw-r--r--doc/enginio_overview.qdoc48
-rw-r--r--doc/qtenginiooverview.qdocconf11
3 files changed, 17 insertions, 44 deletions
diff --git a/doc/enginio_global.qdocconf b/doc/enginio_global.qdocconf
index e4b0c01..62c7f63 100644
--- a/doc/enginio_global.qdocconf
+++ b/doc/enginio_global.qdocconf
@@ -1,2 +1,2 @@
-navigation.homepage = "Enginio $QT_VER"
+navigation.homepage = "Enginio Manual"
buildversion = "Enginio $QT_VERSION Reference Documentation" \ No newline at end of file
diff --git a/doc/enginio_overview.qdoc b/doc/enginio_overview.qdoc
index 6ae91ff..1169f72 100644
--- a/doc/enginio_overview.qdoc
+++ b/doc/enginio_overview.qdoc
@@ -26,10 +26,8 @@
****************************************************************************/
/*!
-\page index.html
-\contentspage {Enginio Manual}{Contents}
-\indexpage Enginio Manual
-\startpage Enginio Manual
+\page enginio-index.html
+\contentspage {enginio-index.html}{Contents}
\nextpage Enginio Installation and Prerequisites
\title Enginio Manual
@@ -106,10 +104,9 @@ The entire Enginio documentation including backend and client is available here:
*/
/*!
-\page enginio-getting-started
-\indexpage Enginio Manual
+\page enginio-getting-started.html
\nextpage Getting Started with Enginio using Qt Quick
-\previouspage Enginio Manual
+\previouspage {enginio-index.html}{Enginio Manual}
\title Enginio Installation and Prerequisites
@@ -120,17 +117,15 @@ This guide can be also applied when integrating Enginio with existing Qt project
\section1 Prerequisites
Enginio comes with Qt 5.2 and later (for 5.2.0 only in the online installer).
-Make sure to select the Enginio component in the \tt{Qt Cloud Services} category.
+Make sure to select the Enginio component in the \e {Qt Cloud Services} category.
-\note Make sure to have OpenSSL installed for Enginio to work.
-
-On iOS openSSL is not required since the native SSL framework is used.
+\note Make sure to have OpenSSL installed for Enginio to work. On iOS, OpenSSL is not
+required as the native SSL framework is used.
*/
/*!
-\page enginio-qml
-\indexpage Enginio Manual
+\page enginio-qml.html
\nextpage Getting Started with Enginio using C++
\previouspage Enginio Installation and Prerequisites
@@ -183,8 +178,7 @@ Now you can \l{Checking stored objects in the Dashboard}{check the Enginio dashb
/*!
-\page enginio-cpp
-\indexpage Enginio Manual
+\page enginio-cpp.html
\nextpage Checking stored objects in the Dashboard
\previouspage Getting Started with Enginio using Qt Quick
@@ -226,12 +220,12 @@ Create an object in JSON format and fill in the data:
city.insert("population", 624000);
\endcode
-Create the object in the Enginio database by calling \l{EnginioClient::create()}:
+Create the object in the Enginio database by calling \l{EnginioClient}{EnginioClient::create()}:
\code
client->create(city);
connect(client, SIGNAL(finished(EnginioReply*)), this, SLOT(uploadFinished(EnginioReply*)));
\endcode
-Note that the \l{EnginioClient::create()}{create()} method performs the actual asynchronous network communication.
+Note that the \c create() method performs the actual asynchronous network communication.
You need to wait for its completion by connecting to the \l{EnginioClient::finished()}{finished} and \l{EnginioClient::error()}{error} signals.
Now you can \l{Checking stored objects in the Dashboard}{check the Enginio dashboard} for the newly created object.
@@ -241,7 +235,6 @@ Now you can \l{Checking stored objects in the Dashboard}{check the Enginio dashb
/*!
\page enginio-dashboard.html
\title Checking Stored Objects in the Dashboard
-\indexpage Enginio Manual
\previouspage Getting Started with Enginio using C++
When you have successfully stored objects with Qt C++ or QML code, go to your \l{https://dashboard.engin.io/}{Enginio Dashboard}
@@ -261,7 +254,6 @@ To get convenient access to objects stored in Enginio, consider using \l Enginio
/*!
\page tutorials.html
\title Enginio Tutorials
-\indexpage Enginio Manual
\list
\li \l {Enginio Installation and Prerequisites}
@@ -270,21 +262,3 @@ To get convenient access to objects stored in Enginio, consider using \l Enginio
\endlist
*/
-/*!
-\page enginio-classes.html
-\title Enginio C++ Classes
-\indexpage Enginio Manual
-
-Enginio provides these \b{C++ classes}:
-\generatelist {classesbymodule enginio-qt}
-*/
-
-/*!
-\page enginio-qml-types.html
-\title Enginio QML Types
-\indexpage Enginio Manual
-
-Enginio provides these \b{QML types}:
-\annotatedlist engino-qml
-*/
-
diff --git a/doc/qtenginiooverview.qdocconf b/doc/qtenginiooverview.qdocconf
index 3c8c701..638fa00 100644
--- a/doc/qtenginiooverview.qdocconf
+++ b/doc/qtenginiooverview.qdocconf
@@ -4,7 +4,7 @@ include(enginio_global.qdocconf)
project = QtEnginioOverview
description = Enginio Client Library
-url = http://engin.io
+url = http://qt-project.org/doc/qt-$QT_VER
version = $QT_VERSION
sourcedirs += .
@@ -17,7 +17,7 @@ depends += qtcore qtgui qtwidgets qtnetwork qtdoc qtenginio qtenginioqml
qhp.projects = QtEnginioOverview
qhp.QtEnginioOverview.file = qtenginiooverview.qhp
-qhp.QtEnginioOverview.namespace = io.engin.overview.$QT_VERSION_TAG
+qhp.QtEnginioOverview.namespace = org.qt-project.qtenginiooverview.$QT_VERSION_TAG
qhp.QtEnginioOverview.virtualFolder = enginiooverview
qhp.QtEnginioOverview.indexTitle = Enginio Manual
@@ -25,8 +25,7 @@ qhp.QtEnginioOverview.filterAttributes = enginio $QT_VERSION
qhp.QtEnginioOverview.customFilters.Qt.name = Enginio $QT_VERSION
qhp.QtEnginioOverview.customFilters.Qt.filterAttributes = enginio $QT_VERSION
-qhp.QtEnginioOverview.subprojects = manual
-qhp.QtEnginioOverview.subprojects.manual.title = Manual
+qhp.QtEnginioOverview.subprojects = manual
+qhp.QtEnginioOverview.subprojects.manual.title = Enginio Manual
qhp.QtEnginioOverview.subprojects.manual.indexTitle = Enginio Manual
-qhp.QtEnginioOverview.subprojects.manual.selectors = fake:page
-
+qhp.QtEnginioOverview.subprojects.manual.type = manual