diff options
author | Topi Reinio <topi.reinio@qt.io> | 2021-06-03 14:00:31 +0200 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2021-06-07 17:44:23 +0200 |
commit | e33ea267f7b898ea810f254452dbd1b216b3a8c7 (patch) | |
tree | 0db71423f19a35446e35e54e8245aec9abb20f01 /src/corelib | |
parent | 1924f78df68d69fa7c69c394c547307e25dfffe1 (diff) |
Doc: QtCore: Fix more documentation warnings
* Omit 'Bluetooth' enum value in QPermission::PermisionType (sic)
as that seems to be unimplemented.
* Comment out \sa links to internal/undocumented functions.
* Fix incomplete template parameters in \fn commands for
QProperty methods.
Task-number: QTBUG-93995
Change-Id: Ic8e63fca22c9c72325c76f90f537b221f56ebace
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/corelib')
-rw-r--r-- | src/corelib/global/qglobal.cpp | 2 | ||||
-rw-r--r-- | src/corelib/kernel/qpermission.qdoc | 2 | ||||
-rw-r--r-- | src/corelib/kernel/qproperty.cpp | 10 | ||||
-rw-r--r-- | src/corelib/platform/android/qandroidextras.cpp | 2 | ||||
-rw-r--r-- | src/corelib/platform/android/qandroidnativeinterface.cpp | 2 |
5 files changed, 10 insertions, 8 deletions
diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp index 94050d5595..9b47055285 100644 --- a/src/corelib/global/qglobal.cpp +++ b/src/corelib/global/qglobal.cpp @@ -3871,7 +3871,7 @@ bool qunsetenv(const char *varName) \relates <QtGlobal> \since 6.2 - Converts the enumerator \e to the equivalent value expressed in its + Converts the enumerator \a e to the equivalent value expressed in its enumeration's underlying type. */ diff --git a/src/corelib/kernel/qpermission.qdoc b/src/corelib/kernel/qpermission.qdoc index 02fd377d64..a5c33eb477 100644 --- a/src/corelib/kernel/qpermission.qdoc +++ b/src/corelib/kernel/qpermission.qdoc @@ -74,6 +74,8 @@ \value WriteCalendar Write to the user's calendar. Maps to \c "android.permission.WRITE_CALENDAR" on Android. + \omitvalue Bluetooth + \note Both Android and iOS require the native permission values to be added to the \c AndroidManifest.xml and \c info.plist respectively. For more information on Android permissions, see \c {Qt Creator: Editing Manifest Files}. diff --git a/src/corelib/kernel/qproperty.cpp b/src/corelib/kernel/qproperty.cpp index 0df73ad639..bff65cd165 100644 --- a/src/corelib/kernel/qproperty.cpp +++ b/src/corelib/kernel/qproperty.cpp @@ -1001,7 +1001,7 @@ QString QPropertyBindingError::description() const \return \c true when the binding was successfully set. - \sa QUntypedPropertyBinding::valueMetaType() + //! \sa QUntypedPropertyBinding::valueMetaType() */ /*! @@ -1017,7 +1017,7 @@ QString QPropertyBindingError::description() const Returns the metatype of the property from which the QUntypedBindable was created. If the bindable is invalid, an invalid metatype will be returned. - \sa isValid(), QUntypedPropertyBinding::valueMetaType() + \sa isValid() //!, QUntypedPropertyBinding::valueMetaType() */ /*! @@ -1287,7 +1287,7 @@ QString QPropertyBindingError::description() const */ /*! - \fn QPropertyNotifier QProperty<T>::addNotifier(Functor f) + \fn template <typename T> template <typename Functor> QPropertyNotifier QProperty<T>::addNotifier(Functor f) Subscribes the given functor \a f as a callback that is called whenever the value of the property changes. @@ -1628,7 +1628,7 @@ QString QPropertyBindingError::description() const \note If this property has a binding (i.e. hasBinding() returns true), that binding is not reevaluated when notify() is called. Any binding depending on this property is still reevaluated as usual. - \sa Qt::beginProperytUpdateGroup(), setValueBypassingBindings() + \sa Qt::beginPropertyUpdateGroup(), setValueBypassingBindings() */ /*! @@ -1973,7 +1973,7 @@ QString QPropertyBindingError::description() const */ /*! - \fn template <typename T> QPropertyNotifier QPropertyAlias<T>::addNotifier(Functor f) + \fn template <typename T> template <typename Functor> QPropertyNotifier QPropertyAlias<T>::addNotifier(Functor f) Subscribes the given functor \a f as a callback that is called whenever the value of the aliased property changes. diff --git a/src/corelib/platform/android/qandroidextras.cpp b/src/corelib/platform/android/qandroidextras.cpp index 22d7300d4b..e58e1a1179 100644 --- a/src/corelib/platform/android/qandroidextras.cpp +++ b/src/corelib/platform/android/qandroidextras.cpp @@ -739,7 +739,7 @@ QAndroidIntent::QAndroidIntent(const QString &action) auto serviceIntent = QAndroidIntent(QtAndroidPrivate::androidActivity().object(), "com.example.MyService"); \endcode - \sa QtAndroidPrivate::androidActivity, QtAndroidPrivate::bindService + \sa QtAndroidPrivate::bindService */ QAndroidIntent::QAndroidIntent(const QJniObject &packageContext, const char *className) : m_handle("android/content/Intent", "(Landroid/content/Context;Ljava/lang/Class;)V", diff --git a/src/corelib/platform/android/qandroidnativeinterface.cpp b/src/corelib/platform/android/qandroidnativeinterface.cpp index 86723cc33b..185f9c2daa 100644 --- a/src/corelib/platform/android/qandroidnativeinterface.cpp +++ b/src/corelib/platform/android/qandroidnativeinterface.cpp @@ -178,7 +178,7 @@ void QNativeInterface::QAndroidApplication::hideSplashScreen(int duration) \note Becareful about the type of operations you do on the Android's main thread, as any long operation can block the app's UI rendering and input handling. If the function is expected to have long execution time, it's - also good to use a \l QDeadlineTimer() in your \a runnable to manage + also good to use a \l QDeadlineTimer in your \a runnable to manage the execution and make sure it doesn't block the UI thread. Usually, any operation longer than 5 seconds might block the app's UI. For more information, see \l {Android: Keeping your app responsive}{Keeping your app responsive}. |