summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAssam Boudjelthia <assam.boudjelthia@qt.io>2020-04-22 18:39:53 +0300
committerAssam Boudjelthia <assam.boudjelthia@qt.io>2020-04-25 09:33:35 +0300
commitb200d03464589d5869e80a0aadff22cc39ea8ac2 (patch)
tree4cb619f61710e090c16d8742d39fbe4228e70d6e
parentb67ed634117e645b33e200fe4d6b4137f6399df2 (diff)
Add \brief tags to classes
Task-number: QTBUG-80390 Change-Id: Ie37723184980c37bde6f868c3a85294b926673dd Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--src/androidextras/android/qandroidbinder.cpp6
-rw-r--r--src/androidextras/android/qandroidintent.cpp4
-rw-r--r--src/androidextras/android/qandroidparcel.cpp4
-rw-r--r--src/androidextras/android/qandroidservice.cpp4
-rw-r--r--src/androidextras/android/qandroidserviceconnection.cpp4
-rw-r--r--src/androidextras/jni/qandroidjnienvironment.cpp1
6 files changed, 18 insertions, 5 deletions
diff --git a/src/androidextras/android/qandroidbinder.cpp b/src/androidextras/android/qandroidbinder.cpp
index 76ae57a..1639454 100644
--- a/src/androidextras/android/qandroidbinder.cpp
+++ b/src/androidextras/android/qandroidbinder.cpp
@@ -72,8 +72,12 @@ QAndroidBinderPrivate::~QAndroidBinderPrivate()
/*!
\class QAndroidBinder
\inmodule QtAndroidExtras
+ \brief Wraps the most important methods of Android Binder class.
+
The QAndroidBinder is a convenience class that wraps the most important
- \l {https://developer.android.com/reference/android/os/Binder.html} {Android Binder} methods.
+ \l {https://developer.android.com/reference/android/os/Binder.html}{Android Binder}
+ methods.
+
\since 5.10
*/
diff --git a/src/androidextras/android/qandroidintent.cpp b/src/androidextras/android/qandroidintent.cpp
index ee6accf..9c0fecb 100644
--- a/src/androidextras/android/qandroidintent.cpp
+++ b/src/androidextras/android/qandroidintent.cpp
@@ -50,9 +50,11 @@ QT_BEGIN_NAMESPACE
/*!
\class QAndroidIntent
\inmodule QtAndroidExtras
+ \brief Wraps the most important methods of Android Intent class.
The QAndroidIntent is a convenience class that wraps the most important
- \l {https://developer.android.com/reference/android/content/Intent.html} {Android Intent} methods.
+ \l {https://developer.android.com/reference/android/content/Intent.html}{Android Intent}
+ methods.
\since 5.10
*/
diff --git a/src/androidextras/android/qandroidparcel.cpp b/src/androidextras/android/qandroidparcel.cpp
index c2e80a0..6923f87 100644
--- a/src/androidextras/android/qandroidparcel.cpp
+++ b/src/androidextras/android/qandroidparcel.cpp
@@ -132,9 +132,11 @@ QAndroidBinder QAndroidParcelPrivate::readBinder() const
/*!
\class QAndroidParcel
\inmodule QtAndroidExtras
+ \brief Wraps the most important methods of Android Parcel class.
The QAndroidParcel is a convenience class that wraps the most important
- \l {https://developer.android.com/reference/android/os/Parcel.html} {Android Parcel} methods.
+ \l {https://developer.android.com/reference/android/os/Parcel.html}{Android Parcel}
+ methods.
\since 5.10
*/
diff --git a/src/androidextras/android/qandroidservice.cpp b/src/androidextras/android/qandroidservice.cpp
index 5359e0f..331f04a 100644
--- a/src/androidextras/android/qandroidservice.cpp
+++ b/src/androidextras/android/qandroidservice.cpp
@@ -105,9 +105,11 @@ public:
/*!
\class QAndroidService
\inmodule QtAndroidExtras
+ \brief Wraps the most important methods of Android Service class.
The QAndroidService is a convenience class that wraps the most important
- \l {https://developer.android.com/reference/android/app/Service.html} {Android Service} methods.
+ \l {https://developer.android.com/reference/android/app/Service.html}{Android Service}
+ methods.
\since 5.10
*/
diff --git a/src/androidextras/android/qandroidserviceconnection.cpp b/src/androidextras/android/qandroidserviceconnection.cpp
index fb4f3da..57e61a2 100644
--- a/src/androidextras/android/qandroidserviceconnection.cpp
+++ b/src/androidextras/android/qandroidserviceconnection.cpp
@@ -46,9 +46,11 @@ QT_BEGIN_NAMESPACE
/*!
\class QAndroidServiceConnection
\inmodule QtAndroidExtras
+ \brief Wraps the most important methods of Android ServiceConnection class.
The QAndroidServiceConnection is a convenience abstract class which wraps the
- \l {https://developer.android.com/reference/android/content/ServiceConnection.html} {Android ServiceConnection} interface.
+ \l {https://developer.android.com/reference/android/content/ServiceConnection.html}{Android ServiceConnection}
+ interface.
It is useful when you perform a QtAndroid::bindService operation.
diff --git a/src/androidextras/jni/qandroidjnienvironment.cpp b/src/androidextras/jni/qandroidjnienvironment.cpp
index 585c442..85db472 100644
--- a/src/androidextras/jni/qandroidjnienvironment.cpp
+++ b/src/androidextras/jni/qandroidjnienvironment.cpp
@@ -139,6 +139,7 @@ static void clearException(bool silent)
/*!
\class QAndroidJniExceptionCleaner
\inmodule QtAndroidExtras
+ \brief Cleans pending JNI exceptions.
The QAndroidJniExceptionCleaner is a convenience class useful to clean
the pending JNI exceptions from the current scope.