Document QStateMachine::running property in single place
authorLouai Al-Khanji <louai.al-khanji@theqtcompany.com>
Mon, 24 Aug 2015 07:32:51 +0000 (10:32 +0300)
committerLouai Al-Khanji <louai.al-khanji@theqtcompany.com>
Tue, 25 Aug 2015 06:01:19 +0000 (06:01 +0000)
This fixes a number of qdoc warnings due to e.g. missing documentation
for setter argument.

Change-Id: If9ae43f70f0e42fe8b8a4f04f49d522cd7d69099
Reviewed-by: Kevin Funk <kevin.funk@kdab.com>
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
src/corelib/statemachine/qstatemachine.cpp

index 237b19bc0e9a204e4da4130ec011592090a250b0..687f6768198f927ad045e2a041d23c2af7a02149 100644 (file)
@@ -160,6 +160,8 @@ QT_BEGIN_NAMESPACE
     \since 5.4
 
     \brief the running state of this state machine
+
+    \sa start(), stop(), started(), stopped(), runningChanged()
 */
 
 #ifndef QT_NO_ANIMATION
@@ -2576,11 +2578,6 @@ void QStateMachine::removeState(QAbstractState *state)
     state->setParent(0);
 }
 
-/*!
-  Returns whether this state machine is running.
-
-  \sa start(), stop()
-*/
 bool QStateMachine::isRunning() const
 {
     Q_D(const QStateMachine);
@@ -2643,11 +2640,6 @@ void QStateMachine::stop()
     }
 }
 
-/*!
-    Convenience functions to start/stop this state machine.
-
-    \sa start(), stop(), started(), finished(), stopped()
-*/
 void QStateMachine::setRunning(bool running)
 {
     if (running)