Doc: Fix documentation warnings

QDoc in Qt 5.11 uses Clang to parse C++ documentation, and it's capable
of resolving templated function signatures; adjust the \fn commands
accordingly.

Also, fix one Q_PROPERTY declaration that caused Clang to misintepret
'*>' as an operator.

Change-Id: I87a06dd479caad99955d7e8ee566e9eba36f517b
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>

2 files changed, 23 insertions, 16 deletions

diff --git a/src/scxml/qscxmlstatemachine.cpp b/src/scxml/qscxmlstatemachine.cpp
index c1d9a68..b477292 100644
--- a/src/scxml/qscxmlstatemachine.cpp
+++ b/src/scxml/qscxmlstatemachine.cpp
@@ -94,7 +94,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
 */
 
 /*!
-    \fn QScxmlStateMachine::connectToEvent(const QString &scxmlEventSpec,
+    \fn template<typename PointerToMemberFunction> QMetaObject::Connection QScxmlStateMachine::connectToEvent(
+                                           const QString &scxmlEventSpec,
                                            const QObject *receiver,
                                            PointerToMemberFunction method,
                                            Qt::ConnectionType type)
@@ -113,7 +114,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
 */
 
 /*!
-    \fn QScxmlStateMachine::connectToEvent(const QString &scxmlEventSpec,
+    \fn template<typename Functor> QMetaObject::Connection QScxmlStateMachine::connectToEvent(
+                                           const QString &scxmlEventSpec,
                                            Functor functor,
                                            Qt::ConnectionType type)
 
@@ -131,7 +133,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
 */
 
 /*!
-    \fn QScxmlStateMachine::connectToEvent(const QString &scxmlEventSpec,
+    \fn template<typename Functor> QMetaObject::Connection QScxmlStateMachine::connectToEvent(
+                                           const QString &scxmlEventSpec,
                                            const QObject *context,
                                            Functor functor,
                                            Qt::ConnectionType type)
@@ -150,7 +153,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
 */
 
 /*!
-    \fn QScxmlStateMachine::connectToState(const QString &scxmlStateName,
+    \fn template<typename PointerToMemberFunction> QMetaObject::Connection QScxmlStateMachine::connectToState(
+                                           const QString &scxmlStateName,
                                            const QObject *receiver,
                                            PointerToMemberFunction method,
                                            Qt::ConnectionType type)
@@ -166,7 +170,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
 
 
 /*!
-    \fn QScxmlStateMachine::connectToState(const QString &scxmlStateName,
+    \fn template<typename Functor> QMetaObject::Connection QScxmlStateMachine::connectToState(
+                                           const QString &scxmlStateName,
                                            Functor functor,
                                            Qt::ConnectionType type)
 
@@ -180,7 +185,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
 */
 
 /*!
-    \fn QScxmlStateMachine::connectToState(const QString &scxmlStateName,
+    \fn template<typename Functor> QMetaObject::Connection QScxmlStateMachine::connectToState(
+                                           const QString &scxmlStateName,
                                            const QObject *context,
                                            Functor functor,
                                            Qt::ConnectionType type)
@@ -195,8 +201,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
 */
 
 /*!
-    \fn QScxmlStateMachine::onEntry(const QObject *receiver,
-                                    const char *method)
+    \fn std::function<void(bool)> QScxmlStateMachine::onEntry(
+            const QObject *receiver, const char *method)
 
     Returns a functor that accepts a boolean argument and calls the given
     \a method on \a receiver using QMetaObject::invokeMethod() if that argument
@@ -210,7 +216,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
  */
 
 /*!
-    \fn QScxmlStateMachine::onExit(const QObject *receiver, const char *method)
+    \fn std::function<void(bool)> QScxmlStateMachine::onExit(
+            const QObject *receiver, const char *method)
 
     Returns a functor that accepts a boolean argument and calls the given
     \a method on \a receiver using QMetaObject::invokeMethod() if that argument
@@ -224,7 +231,7 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
  */
 
 /*!
-    \fn QScxmlStateMachine::onEntry(Functor functor)
+    \fn template<typename Functor> QScxmlStateMachine::onEntry(Functor functor)
 
     Returns a functor that accepts a boolean argument and calls the given
     \a functor if that argument is \c true. The given \a functor must not
@@ -235,7 +242,7 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
  */
 
 /*!
-    \fn QScxmlStateMachine::onExit(Functor functor)
+    \fn template<typename Functor> QScxmlStateMachine::onExit(Functor functor)
 
     Returns a functor that accepts a boolean argument and calls the given
     \a functor if that argument is \c false. The given \a functor must not
@@ -246,8 +253,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
  */
 
 /*!
-    \fn QScxmlStateMachine::onEntry(const QObject *receiver,
-                                    PointerToMemberFunction method)
+    \fn template<typename PointerToMemberFunction> QScxmlStateMachine::onEntry(
+            const QObject *receiver, PointerToMemberFunction method)
 
     Returns a functor that accepts a boolean argument and calls the given
     \a method on \a receiver if that argument is \c true and the \a receiver
@@ -259,8 +266,8 @@ Q_LOGGING_CATEGORY(scxmlLog, "scxml.statemachine")
  */
 
 /*!
-    \fn QScxmlStateMachine::onExit(const QObject *receiver,
-                                   PointerToMemberFunction method)
+    \fn template<typename PointerToMemberFunction> QScxmlStateMachine::onExit(
+            const QObject *receiver, PointerToMemberFunction method)
 
     Returns a functor that accepts a boolean argument and calls the given
     \a method on \a receiver if that argument is \c false and the \a receiver
diff --git a/src/scxml/qscxmlstatemachine.h b/src/scxml/qscxmlstatemachine.h
index 2017444..830238c 100644
--- a/src/scxml/qscxmlstatemachine.h
+++ b/src/scxml/qscxmlstatemachine.h
@@ -69,7 +69,7 @@ class Q_SCXML_EXPORT QScxmlStateMachine: public QObject
     Q_PROPERTY(bool initialized READ isInitialized NOTIFY initializedChanged)
     Q_PROPERTY(QScxmlDataModel *dataModel READ dataModel WRITE setDataModel NOTIFY dataModelChanged)
     Q_PROPERTY(QVariantMap initialValues READ initialValues WRITE setInitialValues NOTIFY initialValuesChanged)
-    Q_PROPERTY(QVector<QScxmlInvokableService *> invokedServices READ invokedServices NOTIFY invokedServicesChanged)
+    Q_PROPERTY(QVector<QScxmlInvokableService*> invokedServices READ invokedServices NOTIFY invokedServicesChanged)
     Q_PROPERTY(QString sessionId READ sessionId CONSTANT)
     Q_PROPERTY(QString name READ name CONSTANT)
     Q_PROPERTY(bool invoked READ isInvoked CONSTANT)