aboutsummaryrefslogtreecommitdiffstats
path: root/src/androidextras/android
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2018-03-01 12:40:21 +0100
committerTopi Reiniƶ <topi.reinio@qt.io>2018-04-11 07:19:12 +0000
commitb36bf0b3eaa026e22a87865e106f54be6b520811 (patch)
tree61b10cdf1634851820465ffbf6724e9be6d7f071 /src/androidextras/android
parenta2157a9dd2ee4ed3e998654595544dadaf129fe8 (diff)
Doc: Fix documentation issues when using Clang-enabled QDocv5.11.0-beta4
QDoc in Qt 5.11 uses Clang to parse the C++ source for documentation comments. Unlike the old parser, Clang requires a module header to be present as well as correct include paths to generate the docs correctly. However, these are available from the build system only when building for Android, not when generating the documentation on a system with no Android-related assets. To fix this, create a 'dummy' module header specific to doc builds, add required relative include paths in .qdocconf, and fix the documentation \fn commands to work with Clang. Change-Id: Ia3d4e50ff8756cd8c8aae9cd3c3d1492eb7db328 Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/androidextras/android')
-rw-r--r--src/androidextras/android/qandroidactivityresultreceiver.cpp2
-rw-r--r--src/androidextras/android/qandroidservice.cpp15
2 files changed, 13 insertions, 4 deletions
diff --git a/src/androidextras/android/qandroidactivityresultreceiver.cpp b/src/androidextras/android/qandroidactivityresultreceiver.cpp
index 3a1acd6..2dfe509 100644
--- a/src/androidextras/android/qandroidactivityresultreceiver.cpp
+++ b/src/androidextras/android/qandroidactivityresultreceiver.cpp
@@ -110,7 +110,7 @@ QAndroidActivityResultReceiver::~QAndroidActivityResultReceiver()
}
/*!
- \fn void QAndroidActivityResultReceiver::handleActivityResult(int receiverRequestCode, int resultCode, const QAndroidJniObject &data) = 0;
+ \fn void QAndroidActivityResultReceiver::handleActivityResult(int receiverRequestCode, int resultCode, const QAndroidJniObject &data)
Reimplement this function to get activity results after starting an activity using either QtAndroid::startActivity() or
QtAndroid::startIntentSender(). The \a receiverRequestCode is the request code unique to this receiver which was originally
diff --git a/src/androidextras/android/qandroidservice.cpp b/src/androidextras/android/qandroidservice.cpp
index 227787a..5359e0f 100644
--- a/src/androidextras/android/qandroidservice.cpp
+++ b/src/androidextras/android/qandroidservice.cpp
@@ -114,7 +114,11 @@ public:
/*!
- Creates a new Android Service
+ \fn QAndroidService::QAndroidService(int &argc, char **argv)
+
+ Creates a new Android service, passing \a argc and \a argv as parameters.
+
+ //! Parameter \a flags is omitted in the documentation.
\sa QCoreApplication
*/
@@ -125,9 +129,14 @@ QAndroidService::QAndroidService(int &argc, char **argv, int flags)
}
/*!
- Creates a new Android Service
+ \fn QAndroidService::QAndroidService(int &argc, char **argv, const std::function<QAndroidBinder *(const QAndroidIntent &)> &binder)
+
+ Creates a new Android service, passing \a argc and \a argv as parameters.
+
+ \a binder is used to create a \l {QAndroidBinder}{binder} when needed.
+
+ //! Parameter \a flags is omitted in the documentation.
- \a binder is used to create a binder each when is needed
\sa QCoreApplication
*/
QAndroidService::QAndroidService(int &argc, char **argv, const std::function<QAndroidBinder *(const QAndroidIntent &)> &binder, int flags)