From 58060e7b6b7c22a9171ca73aec2d4914ce309c56 Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Tue, 20 Oct 2020 21:04:23 +0200 Subject: Fix qdoc warnings in QtDBus And remove the limitation to 8 types from the documentation. Change-Id: I92c67368e53d69fd851886c621f3f894f638bae9 Reviewed-by: Thiago Macieira --- src/dbus/qdbuspendingreply.cpp | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) (limited to 'src/dbus/qdbuspendingreply.cpp') diff --git a/src/dbus/qdbuspendingreply.cpp b/src/dbus/qdbuspendingreply.cpp index 7499938184..2eb2526160 100644 --- a/src/dbus/qdbuspendingreply.cpp +++ b/src/dbus/qdbuspendingreply.cpp @@ -53,16 +53,15 @@ \brief The QDBusPendingReply class contains the reply to an asynchronous method call. - The QDBusPendingReply is a template class with up to 8 template - parameters. Those parameters are the types that will be used to - extract the contents of the reply's data. + The QDBusPendingReply is a variadic template class. The template parameters + are the types that will be used to extract the contents of the reply's data. This class is similar in functionality to QDBusReply, but with two important differences: \list \li QDBusReply accepts exactly one return type, whereas - QDBusPendingReply can have from 1 to 8 types + QDBusPendingReply can have any number of types \li QDBusReply only works on already completed replies, whereas QDBusPendingReply allows one to wait for replies from pending calls @@ -199,9 +198,9 @@ */ /*! - \fn template T1 QDBusPendingReply::value() const + \fn template typename Select<0>::Type QDBusPendingReply::value() const - Returns the first argument in this reply, cast to type \c T1 (the + Returns the first argument in this reply, cast to type \c Types[0] (the first template parameter of this class). This is equivalent to calling argumentAt<0>(). @@ -212,14 +211,14 @@ calling thread to block until the reply is processed. If the reply is an error reply, this function returns a default-constructed - \c T1 object, which may be indistinguishable from a valid value. To + \c Types[0] object, which may be indistinguishable from a valid value. To reliably determine whether the message was an error, use isError(). */ /*! - \fn template QDBusPendingReply::operator T1() const + \fn template QDBusPendingReply::operator typename Select<0>::Type() const - Returns the first argument in this reply, cast to type \c T1 (the + Returns the first argument in this reply, cast to type \c Types[0] (the first template parameter of this class). This is equivalent to calling argumentAt<0>(). @@ -230,7 +229,7 @@ calling thread to block until the reply is processed. If the reply is an error reply, this function returns a default-constructed - \c T1 object, which may be indistinguishable from a valid value. To + \c Types[0] object, which may be indistinguishable from a valid value. To reliably determine whether the message was an error, use isError(). */ -- cgit v1.2.3