summaryrefslogtreecommitdiff
path: root/src/types.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2013-01-09 23:18:13 +0000
committerCarl Hetherington <cth@carlh.net>2013-01-09 23:18:13 +0000
commit41daa5821b3d3b0f450094fbf0d1e37a449f482c (patch)
tree623e5aa9370dbb78bba14e9833a4ea0d1e026e22 /src/types.h
parente651d843c513e8dbf0967735ea702a3795ac321d (diff)
Comment tweaks.
Diffstat (limited to 'src/types.h')
-rw-r--r--src/types.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/types.h b/src/types.h
index 433a910c..f1b5f640 100644
--- a/src/types.h
+++ b/src/types.h
@@ -105,6 +105,9 @@ struct EqualityOptions {
int max_audio_sample_error;
};
+/** @class Color
+ * @brief An RGB color (aka colour).
+ */
class Color
{
public:
@@ -112,9 +115,9 @@ public:
Color (int r_, int g_, int b_);
Color (std::string argb_hex);
- int r;
- int g;
- int b;
+ int r; ///< red component, from 0 to 255
+ int g; ///< green component, from 0 to 255
+ int b; ///< blue component, from 0 to 255
std::string to_argb_string () const;
};