summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-03-31 13:02:37 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-31 13:23:31 +0200
commita31f7383e4f81dce6009e62fec1cc9ef6d8b95a7 (patch)
treeb89ae7607a6c1eb102c5fb94ded5f39d66ef6d4e /src
parentc9c27f2bfee8c2d4d5cee1f6b6604a1378dd8730 (diff)
downloadqtenginio-a31f7383e4f81dce6009e62fec1cc9ef6d8b95a7.tar.gz
Doc: Adding \since commands to the C++ and QML API.
-both classes and QML types should have \since. -module introduced in Qt 5.3. Change-Id: I12e0b1df4946dfdf16cd97567b5745b4b308d781 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/enginio_client/enginioclient.cpp3
-rw-r--r--src/enginio_client/enginioidentity.cpp2
-rw-r--r--src/enginio_client/enginiomodel.cpp1
-rw-r--r--src/enginio_client/enginioreply.cpp2
-rw-r--r--src/enginio_plugin/enginioqmlclient.cpp1
-rw-r--r--src/enginio_plugin/enginioqmlmodel.cpp2
-rw-r--r--src/enginio_plugin/enginioqmlreply.cpp1
7 files changed, 10 insertions, 2 deletions
diff --git a/src/enginio_client/enginioclient.cpp b/src/enginio_client/enginioclient.cpp
index 8c53ea5..3fe1536 100644
--- a/src/enginio_client/enginioclient.cpp
+++ b/src/enginio_client/enginioclient.cpp
@@ -68,6 +68,7 @@ QT_BEGIN_NAMESPACE
/*!
\class EnginioClient
+ \since 5.3
\inmodule enginio-qt
\ingroup enginio-client
\target EnginioClientCpp
@@ -102,7 +103,7 @@ QT_BEGIN_NAMESPACE
/*!
\class EnginioClientConnection
-
+ \since 5.3
\inmodule enginio-qt
\ingroup enginio-client
\brief EnginioClientConnection keeps track of the authenticated connection to the server.
diff --git a/src/enginio_client/enginioidentity.cpp b/src/enginio_client/enginioidentity.cpp
index c4e1357..56b8b90 100644
--- a/src/enginio_client/enginioidentity.cpp
+++ b/src/enginio_client/enginioidentity.cpp
@@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE
/*!
\class EnginioIdentity
+ \since 5.3
\inmodule enginio-qt
\ingroup enginio-client
\brief Represents a user that is authenticated with the backend
@@ -213,6 +214,7 @@ public:
/*!
\class EnginioOAuth2Authentication
+ \since 5.3
\inmodule enginio-qt
\ingroup enginio-client
\brief Represents a user that is authenticated directly by the backend using OAuth2 standard.
diff --git a/src/enginio_client/enginiomodel.cpp b/src/enginio_client/enginiomodel.cpp
index 0163de0..72648d5 100644
--- a/src/enginio_client/enginiomodel.cpp
+++ b/src/enginio_client/enginiomodel.cpp
@@ -59,6 +59,7 @@ const int EnginioBaseModelPrivate::IncrementalModelUpdate = -2;
/*!
\class EnginioModel
+ \since 5.3
\inmodule enginio-qt
\ingroup enginio-client
\target EnginioModelCpp
diff --git a/src/enginio_client/enginioreply.cpp b/src/enginio_client/enginioreply.cpp
index e3861dd..b4b8af6 100644
--- a/src/enginio_client/enginioreply.cpp
+++ b/src/enginio_client/enginioreply.cpp
@@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE
/*!
\class EnginioReply
+ \since 5.3
\brief The EnginioReply class contains the data from a request to the Enginio database.
\inmodule enginio-qt
\ingroup enginio-client
@@ -76,6 +77,7 @@ QT_BEGIN_NAMESPACE
/*!
\class EnginioReplyState
+ \since 5.3
\internal
*/
diff --git a/src/enginio_plugin/enginioqmlclient.cpp b/src/enginio_plugin/enginioqmlclient.cpp
index a68541d..7c29cd2 100644
--- a/src/enginio_plugin/enginioqmlclient.cpp
+++ b/src/enginio_plugin/enginioqmlclient.cpp
@@ -56,6 +56,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype EnginioClient
+ \since 5.3
\instantiates EnginioQmlClient
\inqmlmodule Enginio
\ingroup engino-qml
diff --git a/src/enginio_plugin/enginioqmlmodel.cpp b/src/enginio_plugin/enginioqmlmodel.cpp
index 00a33c4..b09b339 100644
--- a/src/enginio_plugin/enginioqmlmodel.cpp
+++ b/src/enginio_plugin/enginioqmlmodel.cpp
@@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype EnginioModel
+ \since 5.3
\instantiates EnginioQmlModel
\inqmlmodule Enginio
\ingroup engino-qml
@@ -293,4 +294,3 @@ void EnginioQmlModel::setOperation(Enginio::Operation operation)
}
QT_END_NAMESPACE
-
diff --git a/src/enginio_plugin/enginioqmlreply.cpp b/src/enginio_plugin/enginioqmlreply.cpp
index 16201af..a205f58 100644
--- a/src/enginio_plugin/enginioqmlreply.cpp
+++ b/src/enginio_plugin/enginioqmlreply.cpp
@@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype EnginioReply
+ \since 5.3
\instantiates EnginioQmlReply
\inqmlmodule Enginio
\ingroup engino-qml