Various tinkerings.

[libdcp.git] / src / types.h

diff --git a/src/types.h b/src/types.h
index 1397dfdcda0538c8ad50a4888d05333aaedcc197..d34a9039be7f2fa724033314119c5d189281aaaa 100644 (file)
--- a/src/types.h
+++ b/src/types.h
@@ -85,12 +85,20 @@ enum Eye
        EYE_LEFT,
        EYE_RIGHT
 };
-       
+
+/** @class Fraction
+ *  @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
+ */
 class Fraction
 {
 public:
+       /** Construct a fraction of 0/0 */
        Fraction () : numerator (0), denominator (0) {}
        Fraction (std::string s);
+       /** Construct a fraction with a specified numerator and denominator.
+        *  @param n Numerator.
+        *  @param d Denominator.
+        */
        Fraction (int n, int d) : numerator (n), denominator (d) {}
 
        int numerator;