Pick up effect and effect color.

[libdcp.git] / src / dcp_time.h

diff --git a/src/dcp_time.h b/src/dcp_time.h
index a611cd89db9b3545de727b2dee32caa7f7941c48..626cdacae1ddb3b4f0ef18249998e6a3436a1643 100644 (file)
--- a/src/dcp_time.h
+++ b/src/dcp_time.h
@@ -17,16 +17,29 @@
 
 */
 
+/** @file  src/dcp_time.h
+ *  @brief A representation of time within a DCP.
+ */
+
 #ifndef LIBDCP_TIME_H
 #define LIBDCP_TIME_H
 
 namespace libdcp {
 
+/** @class Time
+ *  @brief A representation of time within a DCP.
+ */
+       
 class Time
 {
 public:
        Time () : h (0), m (0), s (0), t (0) {}
+
+       /** Construct a Time from a frame index (starting from 0)
+        *  and a frames per second count.
+        */
        Time (int frame, int frames_per_second);
+       
        Time (int h_, int m_, int s_, int t_)
                : h (h_)
                , m (m_)
@@ -34,10 +47,10 @@ public:
                , t (t_)
        {}
 
-       int h;
-       int m;
-       int s;
-       int t;
+       int h; ///< hours
+       int m; ///< minutes
+       int s; ///< seconds
+       int t; ///< `ticks', where 1 tick is 4 milliseconds
 };
 
 extern bool operator== (Time const & a, Time const & b);