Small bits of pre-release tidying.

[libdcp.git] / src / chromaticity.h

diff --git a/src/chromaticity.h b/src/chromaticity.h
index 89b719361cf2578a7bb5cab740238ccf0b543cd2..c62731f73a5a9429f94d7e0c5de651b389bf31c5 100644 (file)
--- a/src/chromaticity.h
+++ b/src/chromaticity.h
@@ -1,22 +1,40 @@
 /*
     Copyright (C) 2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
 
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+/** @file  src/chromaticity.h
+ *  @brief Chromaticity class.
+ */
+
 #ifndef DCP_CHROMATICITY_H
 #define DCP_CHROMATICITY_H
 
@@ -24,6 +42,9 @@
 
 namespace dcp {
 
+/** @class Chromaticity
+ *  @brief A representation of a x,y,z chromaticity, where z = 1 - x - y
+ */
 class Chromaticity
 {
 public:
@@ -36,7 +57,7 @@ public:
                : x (x_)
                , y (y_)
        {}
-               
+
        double x;
        double y;
 
@@ -44,9 +65,12 @@ public:
                return 1 - x - y;
        }
 
+       /** @return true if this Chromaticity's x and y are within epsilon of other */
        bool about_equal (Chromaticity const & other, float epsilon) const {
                return std::fabs (x - other.x) < epsilon && std::fabs (y - other.y) < epsilon;
        }
+
+       static Chromaticity D65 ();
 };
 
 }