Comments / tweaks.

[libdcp.git] / src / xyz_frame.h

diff --git a/src/xyz_frame.h b/src/xyz_frame.h
index a4dcb2c028c0d0c9b25b434783d2686656c66b79..8ba829b2c6302ecde5e08ca3bc6c2b07ae6409f3 100644 (file)
--- a/src/xyz_frame.h
+++ b/src/xyz_frame.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 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,12 +17,21 @@
 
 */
 
-#include <openjpeg.h>
+/** @file  src/xyz_frame.h
+ *  @brief XZYFrame class.
+ */
+
 #include "util.h"
+#include <openjpeg.h>
 
-namespace libdcp {
+namespace dcp {
 
-class XYZFrame
+/** @class XYZFrame
+ *  @brief An image in XYZ colour.
+ *
+ *  This class is a thin wrapper of libopenjpeg's opj_image_t.
+ */
+class XYZFrame : public boost::noncopyable
 {
 public:
        XYZFrame (opj_image_t *);
@@ -30,14 +39,17 @@ public:
        ~XYZFrame ();
 
        int* data (int) const;
-       libdcp::Size size () const;
+       dcp::Size size () const;
 
+       /** @return Pointer to opj_image_t struct.  The caller
+        *  must not delete this.
+        */
        opj_image_t* opj_image () const {
                return _opj_image;
        }
 
 private:
-       opj_image_t* _opj_image;
+       opj_image_t* _opj_image; ///< opj_image_t that we are managing
 };
 
 }