Changeset 67 in pacpusframework for trunk/include/Pacpus/DbitePlayer/DbtPlyEngine.h

Timestamp:

01/09/13 19:17:44 (11 years ago)

Author:

Marek Kurdej

Message:

Documentation: file info.
Fixed: problem with includes in PacpusPluginInterface.h.

File:

• trunk/include/Pacpus/DbitePlayer/DbtPlyEngine.h (modified) (5 diffs)

trunk/include/Pacpus/DbitePlayer/DbtPlyEngine.h

@@ -16 +16 @@
 #define DEF_PACPUS_DBTPLYENGINE_H
 
-#include <QSemaphore>
-
 #include <Pacpus/kernel/ComponentBase.h>
 #include <Pacpus/kernel/ComponentFactory.h>
@@ -24 +22 @@
 #include <Pacpus/DbitePlayer/DbtPlyUserInterface.h>
 
+#include <QSemaphore>
+#include <QThread>
+
 namespace pacpus {
 
@@ -29 +30 @@
 class DbtPlyEngineState;
 
+/// @todo Documentation
 enum PlayMode
 {
-    PlayModeLastData = 1,   // replay_mode="1"
-    PlayModeAllData = 2     // replay_mode="2"
+    PlayModeLastData = 1,   ///< replay_mode="1"
+    PlayModeAllData = 2     ///< replay_mode="2"
 };
 
@@ -61 +63 @@
     }
 
-    /// @returns true if the player is playing
+    /// @returns @b true if the player is playing, @b false otherwise
     bool isPlaying();
     /// Accessor to playmode
@@ -69 +71 @@
     }
 
+    /// @todo Documentation
     const DbtPlyEngineState * getState();
+    /// @todo Documentation
     void setState(DbtPlyEngineState * newState);