summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2020-02-07 11:08:17 +0100
committerEike Ziller <eike.ziller@qt.io>2020-02-07 14:27:41 +0000
commitd9d86782ce1679598d517e1b8cae526e216b7195 (patch)
tree710c85caf871e658ae92cda591492efca15c880d
parentc42ca50537028bccb40a2eb3014677857ea516d4 (diff)
downloadqt-creator-d9d86782ce1679598d517e1b8cae526e216b7195.tar.gz
Add documentation for ExtensionSystem::invoke
Task-number: QTCREATORBUG-23544 Change-Id: I41078ef167f1dd1592cf22a69d0cad13429db201 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--src/libs/extensionsystem/invoker.cpp39
-rw-r--r--src/libs/extensionsystem/invoker.h2
2 files changed, 41 insertions, 0 deletions
diff --git a/src/libs/extensionsystem/invoker.cpp b/src/libs/extensionsystem/invoker.cpp
index 1506c4910a..150dabdaa8 100644
--- a/src/libs/extensionsystem/invoker.cpp
+++ b/src/libs/extensionsystem/invoker.cpp
@@ -27,6 +27,45 @@
namespace ExtensionSystem {
+/*!
+ \class ExtensionSystem::InvokerBase
+ \internal
+*/
+
+/*!
+ \class ExtensionSystem::Invoker
+ \internal
+*/
+
+/*!
+ \fn Result invoke(QObject *target, const char *slot)
+ Invokes \a slot on \a target by name via Qt's meta method system.
+
+ Returns the result of the meta call.
+*/
+
+/*!
+ \fn Result invoke(QObject *target, const char *slot, const T0 &t0)
+ Invokes \a slot on \a target with argument \a t0 by name via Qt's meta method system.
+
+ Returns the result of the meta call.
+*/
+
+/*!
+ \fn Result invoke(QObject *target, const char *slot, const T0 &t0, const T1 &t1)
+ Invokes \a slot on \a target with arguments \a t0 and \a t1 by name via Qt's meta method system.
+
+ Returns the result of the meta call.
+*/
+
+/*!
+ \fn Result invoke(QObject *target, const char *slot, const T0 &t0, const T1 &t1, const T2 &t2)
+ Invokes \a slot on \a target with arguments \a t0, \a t1 and \a t2 by name
+ via Qt's meta method system.
+
+ Returns the result of the meta call.
+*/
+
InvokerBase::InvokerBase()
{
lastArg = 0;
diff --git a/src/libs/extensionsystem/invoker.h b/src/libs/extensionsystem/invoker.h
index 1286e07aaa..6db1a32561 100644
--- a/src/libs/extensionsystem/invoker.h
+++ b/src/libs/extensionsystem/invoker.h
@@ -150,6 +150,7 @@ public:
}
};
+#ifndef Q_QDOC
template <class Result>
Result invokeHelper(InvokerBase &in, QObject *target, const char *slot)
{
@@ -164,6 +165,7 @@ inline void invokeHelper<void>(InvokerBase &in, QObject *target, const char *slo
{
in.invoke(target, slot);
}
+#endif
template<class Result>
Result invoke(QObject *target, const char *slot)