Comments / tweaks.

[libdcp.git] / src / xyz_frame.h

diff --git a/src/xyz_frame.h b/src/xyz_frame.h
index 5319f9d4239608915393214f61bf1452ffb10639..8ba829b2c6302ecde5e08ca3bc6c2b07ae6409f3 100644 (file)
--- a/src/xyz_frame.h
+++ b/src/xyz_frame.h
@@ -26,8 +26,10 @@
 
 namespace dcp {
 
-/* @class XYZFrame
- * @brief An image in XYZ colour.
+/** @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
 {
@@ -39,12 +41,15 @@ public:
        int* data (int) 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
 };
 
 }