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

Timestamp:

01/09/13 13:40:39 (11 years ago)

Author:

Marek Kurdej

Message:

Added: some documentation and doc todo comments.

File:

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

trunk/include/Pacpus/DbitePlayer/DbtPlyEngine.h

@@ -71 +71 @@
     void reset();
 
+    /// @todo Documentation
     void speedUp();
+    /// @todo Documentation
     void speedDown();
+    /// @todo Documentation
     void setLastTNow(road_time_t newTNow)
     {
@@ -79 +82 @@
 
 protected:
-    // The 3 virtual methods relative to the ComponentBase inheritance
+    /// @todo Documentation
     virtual void startActivity();
+    /// @todo Documentation
     virtual void stopActivity();
+    /// @todo Documentation
     virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config);
 
@@ -122 +127 @@
 
 Q_SIGNALS:
+    /// @todo Documentation
     void play(road_time_t timeToPlay, road_time_t actualTime, bool direction);
+    /// @todo Documentation
     void stopfile();
+    /// @todo Documentation
     void displayStateSig(DbtPlyEngineState * state, float speed);
+    /// @todo Documentation
     void timeMinMax(road_time_t tMin, road_time_t tMax);
+    /// @todo Documentation
     void curReplayTime(road_time_t time);
 
 public Q_SLOTS:
+    /// @todo Documentation
     void engReceiver();
+    /// @todo Documentation
     void changeDirection(bool reverse);
+    /// @todo Documentation
     void tMinMax(road_time_t tMin, road_time_t tMax);
 
+    /// @todo Documentation
     void playEvent();
+    /// @todo Documentation
     void pauseEvent();
+    /// @todo Documentation
     void stopEvent();
+    /// @todo Documentation
     void speedUpEvent();
+    /// @todo Documentation
     void speedDownEvent();
 };