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>
This commit is contained in:
Topi Reinio 2021-06-03 14:00:31 +02:00
parent 1924f78df6
commit e33ea267f7
5 changed files with 10 additions and 8 deletions

View File

@ -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.
*/

View File

@ -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}.

View File

@ -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.

View File

@ -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",

View File

@ -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}.