Changeset 67 in pacpusframework for trunk/include/Pacpus/DbitePlayer

Timestamp:

Jan 9, 2013, 7:17:44 PM (12 years ago)

Author:

Marek Kurdej

Message:

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

Location:

trunk/include/Pacpus/DbitePlayer

Files:

• DbtPlyEngine.h (modified) (5 diffs)
• DbtPlyFileManager.h (modified) (6 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);
 

trunk/include/Pacpus/DbitePlayer/DbtPlyFileManager.h

@@ -23 +23 @@
 #define DEF_PACPUS_DBTPLYFILEMANAGER_H
 
-#include <QThread>
-
 #include <Pacpus/DbitePlayer/DbitePlayerConfig.h>
 #include <Pacpus/DbitePlayer/DbtPlyEngine.h>
@@ -30 +28 @@
 #include <Pacpus/kernel/ComponentBase.h>
 #include <Pacpus/kernel/DbiteFile.h>
+
+#include <QThread>
 
 class QSemaphore;
@@ -66 +66 @@
     /// virtual method: call when new DBT data are replayed
     virtual void processData(road_time_t time, road_timerange_t timeRange, void * data) = 0;
+    /// @todo Documentation
     virtual void displayUI();
 
@@ -98 +99 @@
     /// the absolute path of the DBT file
     QString dbtProperty_;
+    /// @todo Documentation
     QStringList mDbtFilenameList;
 
@@ -109 +111 @@
     struct dbtStruct
     {
+        /// Data buffer
         char * buffer;
+        /// Acquisition time
         road_time_t t;
+        /// Acquisition timerange
         road_timerange_t tr;
     };
@@ -117 +122 @@
     struct dbtStructFile
     {
-        // the DBT file descriptor
+        /// the DBT file descriptor
         pacpus::DbiteFile * pfile;
-        // the buffer where the data are stored after the reading and the associated time, timerange and file descriptor
+        /// the buffer where the data are stored after the reading and the associated time, timerange and file descriptor
         dbtStruct cur;
-        // the previous DBT data, these ones that must be processed
+        /// the previous DBT data, these ones that must be processed
         dbtStruct toProcess;
     };
 
+    /// @todo Documentation
     QList<dbtStructFile> dbt_;
+    /// @todo Documentation
     int dbtIndex_;