Comment tweaks.

2 files changed, 26 insertions, 1 deletions

diff --git a/src/argb_frame.h b/src/argb_frame.h
index bc78b8fb..1adbbd14 100644
--- a/src/argb_frame.h
+++ b/src/argb_frame.h
@@ -17,11 +17,30 @@
 
 */
 
+/** @file  src/argb_frame.h
+ *  @brief Container for a single image from a picture asset.
+ */
+
 #include <stdint.h>
 
 namespace libdcp
 {
 
+/** @class ARGBFrame
+ *  @brief A single frame of picture data held in an ARGB buffer.
+ *
+ *  The format of the data is:
+ *
+ *  <pre>
+ *  Byte   /- 0 -------|- 1 --------|- 2 --------|- 3 --------|- 4 --------|- 5 --------| ...
+ *         |(0, 0) Blue|(0, 0) Red  |(0, 0) Blue |(0, 0) Alpha|(0, 1) Blue |(0, 1) Red  | ...
+ *  </pre>
+ *
+ *  So that the first byte is the blue component of the pixel at x=0, y=0, the second
+ *  is the red component, and so on.
+ *
+ *  Lines are packed so that the second row directly follows the first.
+ */
 class ARGBFrame
 {
 public:
@@ -32,6 +51,7 @@ public:
 		return _data;
 	}
 
+	/** Length of one picture row in bytes */
 	int stride () const;
 
 private:
diff --git a/src/cpl.h b/src/cpl.h
index e06e2351..8f5682da 100644
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -125,7 +125,12 @@ public:
 	std::string label_text;
 };
 
-/** Class to parse a CPL */
+/** @class CPL
+ *  @brief Class to parse a CPL
+ *
+ *  This class is used to parse XML CPL files.  It is rarely necessary
+ *  for the caller to use it outside libdcp.
+ */
 class CPL : public XMLFile
 {
 public: