Cleanup: rename parse_style -> parse_tag and STYLE to TAG.

[libsub.git] / src / colour.h

diff --git a/src/colour.h b/src/colour.h
index 4989277400ca2c083b4470daa2d93535874edbe7..241f7384035fbf2e11f8d53629314788c7eeb996 100644 (file)
--- a/src/colour.h
+++ b/src/colour.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,13 +17,21 @@
 
 */
 
+/** @file  src/colour.h
+ *  @brief Colour class.
+ */
+
 #ifndef LIBSUB_COLOUR_H
 #define LIBSUB_COLOUR_H
 
 #include <string>
+#include <cmath>
 
 namespace sub {
 
+/** @class Colour
+ *  @brief An RGB colour.
+ */
 class Colour
 {
 public:
@@ -32,14 +40,15 @@ public:
                , g (0)
                , b (0)
        {}
-       
+
        Colour (float r, float g, float b)
                : r (r)
                , g (g)
                , b (b)
        {}
 
-       Colour (std::string);
+       static Colour from_rgba_hex(std::string);
+       static Colour from_rgb_hex (std::string);
 
        /** red component (from 0 to 1) */
        float r;
@@ -51,7 +60,7 @@ public:
 
 bool
 operator== (Colour const & a, Colour const & b);
-       
+
 }
 
 #endif