1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

QMetaType: fix documentation

Browse Source 
The doc comments were missing the classname, and therefore did not show
up in the correct places.

Change-Id: I23a56356dcad862e2fe1f6f8c3da2f39852b80c7
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
(cherry picked from commit 2d6ca88512f9e318491c502f6f97d2e853ffca4a)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Fabian Kosmale 2022-07-15 13:19:37 +02:00 committed by Qt Cherry-pick Bot
parent f83a79f267
commit caa7970df8
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/corelib/kernel/qmetatype.cpp
View File

@ -1591,7 +1591,7 @@ Q_GLOBAL_STATIC(QMetaTypeMutableViewRegistry, customTypesMutableViewRegistry)
*/ */
/*! /*!
\fn template<typename From, typename To> static bool registerConverter(To(From::*function)() const) \fn template<typename From, typename To> static bool QMetaType::registerConverter(To(From::*function)() const)
\since 5.2 \since 5.2
\overload \overload
Registers a method \a function like To From::function() const as converter from type From Registers a method \a function like To From::function() const as converter from type From
@ -1601,25 +1601,25 @@ Q_GLOBAL_STATIC(QMetaTypeMutableViewRegistry, customTypesMutableViewRegistry)
*/ */
/*! /*!
\fn template<typename From, typename To> static bool registerConverter(To(From::*function)(bool*) const) \fn template<typename From, typename To> static bool QMetaType::registerConverter(To(From::*function)(bool*) const)
\since 5.2 \since 5.2
\overload \overload
Registers a method \a function like To From::function(bool *ok) const as converter from type From Registers a method \a function like To From::function(bool *ok) const as converter from type From
to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false. to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
The \a ok pointer can be used by the function to indicate whether the conversion succeeded. The \c ok pointer can be used by the function to indicate whether the conversion succeeded.
\snippet qmetatype/registerConverters.cpp memberOk \snippet qmetatype/registerConverters.cpp memberOk
*/ */
/*! /*!
\fn template<typename From, typename To, typename UnaryFunction> static bool registerConverter(UnaryFunction function) \fn template<typename From, typename To, typename UnaryFunction> static bool QMetaType::registerConverter(UnaryFunction function)
\since 5.2 \since 5.2
\overload \overload
Registers a unary function object \a function as converter from type From Registers a unary function object \a function as converter from type From
to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false. to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
\a function must take an instance of type \a From and return an instance of \a To. It can be a function \a function must take an instance of type \c From and return an instance of \c To. It can be a function
pointer, a lambda or a functor object. pointer, a lambda or a functor object.
\snippet qmetatype/registerConverters.cpp unaryfunc \snippet qmetatype/registerConverters.cpp unaryfunc
*/ */
@ -1642,7 +1642,7 @@ bool QMetaType::registerConverterFunction(const ConverterFunction &f, QMetaType
} }
/*! /*!
\fn template<typename From, typename To> static bool registerMutableView(To(From::*function)()) \fn template<typename From, typename To> static bool QMetaType::registerMutableView(To(From::*function)())
\since 6.0 \since 6.0
\overload \overload
Registers a method \a function like \c {To From::function()} as mutable view of type \c {To} on Registers a method \a function like \c {To From::function()} as mutable view of type \c {To} on
@ -1651,7 +1651,7 @@ bool QMetaType::registerConverterFunction(const ConverterFunction &f, QMetaType
*/ */
/*! /*!
\fn template<typename From, typename To, typename UnaryFunction> static bool registerMutableView(UnaryFunction function) \fn template<typename From, typename To, typename UnaryFunction> static bool QMetaType::registerMutableView(UnaryFunction function)
\since 6.0 \since 6.0
\overload \overload
Registers a unary function object \a function as mutable view of type To on type From Registers a unary function object \a function as mutable view of type To on type From