From 2ee4dc0502a9bbdb1f6db69fc8bc4b1d4c107009 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Str=C3=B8mme?= Date: Thu, 20 Feb 2014 14:43:29 +0100 Subject: Fix documentation for QAndroidJniObject MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit QDoc does not differentiate between the templated and non-templated versions of the same function. Change-Id: Ifa5cfcf0780c267e996a64fd76581032126f0247 Reviewed-by: Jerome Pasion Reviewed-by: Jędrzej Nowacki Reviewed-by: Martin Smith --- src/androidextras/jni/qandroidjniobject.cpp | 39 +++++++++++++++++++++++++++-- src/androidextras/jni/qandroidjniobject.h | 8 ++++++ 2 files changed, 45 insertions(+), 2 deletions(-) (limited to 'src/androidextras/jni') diff --git a/src/androidextras/jni/qandroidjniobject.cpp b/src/androidextras/jni/qandroidjniobject.cpp index 2448d54..43e6e70 100644 --- a/src/androidextras/jni/qandroidjniobject.cpp +++ b/src/androidextras/jni/qandroidjniobject.cpp @@ -464,12 +464,22 @@ QT_BEGIN_NAMESPACE \fn QAndroidJniObject QAndroidJniObject::getObjectField(const char *fieldName) const Retrieves the object of field \a fieldName. + + \code + QAndroidJniObject field = jniObject.getObjectField("FIELD_NAME"); + \endcode */ /*! \fn QAndroidJniObject QAndroidJniObject::getObjectField(const char *fieldName, const char *signature) const Retrieves the object from the field with \a signature and \a fieldName. + + \note Since \b{Qt 5.3} this function can be used without a template type. + + \code + QAndroidJniObject field = jniObject.getObjectField("FIELD_NAME", "Ljava/lang/String;"); + \endcode */ /*! @@ -488,24 +498,42 @@ QT_BEGIN_NAMESPACE \fn QAndroidJniObject QAndroidJniObject::getStaticObjectField(const char *className, const char *fieldName) Retrieves the object from the field \a fieldName on the class \a className. + + \code + QAndroidJniObject jobj = QAndroidJniObject::getStaticObjectField("class/with/Fields", "FIELD_NAME"); + \endcode */ /*! \fn QAndroidJniObject QAndroidJniObject::getStaticObjectField(const char *className, const char *fieldName, const char *signature) - Retrieves the object from the field with \a signature and \a fieldName on class \a className. + + \note Since \b{Qt 5.3} this function can be used without a template type. + + \code + QAndroidJniObject jobj = QAndroidJniObject::getStaticObjectField("class/with/Fields", "FIELD_NAME", "Ljava/lang/String;"); + \endcode */ /*! \fn QAndroidJniObject QAndroidJniObject::getStaticObjectField(jclass clazz, const char *fieldName) Retrieves the object from the field \a fieldName on \a clazz. + + \code + QAndroidJniObject jobj = QAndroidJniObject::getStaticObjectField(clazz, "FIELD_NAME"); + \endcode */ /*! \fn QAndroidJniObject QAndroidJniObject::getStaticObjectField(jclass clazz, const char *fieldName, const char *signature) - Retrieves the object from the field with \a signature and \a fieldName on \a clazz. + + \note Since \b{Qt 5.3} this function can be used without a template type. + + \code + QAndroidJniObject jobj = QAndroidJniObject::getStaticObjectField(clazz, "FIELD_NAME", "Ljava/lang/String;"); + \endcode */ /*! @@ -602,6 +630,13 @@ QT_BEGIN_NAMESPACE free it yourself. \snippet code/src_androidextras_qandroidjniobject.cpp QAndroidJniObject scope + + \note Since \b{Qt 5.3} this function can be used without a template type, if the returned type + is a \c jobject. + + \code + jobject object = jniObject.object(); + \endcode */ /*! diff --git a/src/androidextras/jni/qandroidjniobject.h b/src/androidextras/jni/qandroidjniobject.h index a1eb4fd..9d880fa 100644 --- a/src/androidextras/jni/qandroidjniobject.h +++ b/src/androidextras/jni/qandroidjniobject.h @@ -64,7 +64,9 @@ public: template inline T object() const { return static_cast(javaObject()); } +#ifndef Q_QDOC inline jobject object() const { return javaObject(); } +#endif // Q_QDOC template T callMethod(const char *methodName) const; @@ -98,9 +100,11 @@ public: T getField(const char *fieldName) const; template QAndroidJniObject getObjectField(const char *fieldName) const; +#ifndef Q_QDOC // ### Qt 6 remove templated version template QAndroidJniObject getObjectField(const char *fieldName, const char *sig) const; +#endif // Q_QDOC QAndroidJniObject getObjectField(const char *fieldName, const char *sig) const; template void setField(const char *fieldName, T value); @@ -108,11 +112,13 @@ public: void setField(const char *fieldName, const char *sig, T value); template static QAndroidJniObject getStaticObjectField(const char *className, const char *fieldName); +#ifndef Q_QDOC // ### Qt 6 remove templated version template static QAndroidJniObject getStaticObjectField(const char *className, const char *fieldName, const char *sig); +#endif // Q_QDOC static QAndroidJniObject getStaticObjectField(const char *className, const char *fieldName, const char *sig); @@ -120,11 +126,13 @@ public: static T getStaticField(const char *className, const char *fieldName); template static QAndroidJniObject getStaticObjectField(jclass clazz, const char *fieldName); +#ifndef Q_QDOC // ### Qt 6 remove templated version template static QAndroidJniObject getStaticObjectField(jclass clazz, const char *fieldName, const char *sig); +#endif // Q_QDOC static QAndroidJniObject getStaticObjectField(jclass clazz, const char *fieldName, const char *sig); -- cgit v1.2.3