Some comments and dead code removal.

diff --git a/src/mxf_asset.h b/src/mxf_asset.h
index cdcd08bf45b36f98997c126832245c46071562a3..7f36b30a0b9476902ea4856b3038f8ea3f4b41fc 100644 (file)
--- a/src/mxf_asset.h
+++ b/src/mxf_asset.h
@@ -33,6 +33,7 @@ public:
         *  @param file_name Name of MXF file.
         *  @param progress Signal to inform of progress.
         *  @param fps Frames per second.
+        *  @param entry_point The entry point of this MXF; ie the first frame that should be used.
         *  @param length Length in frames.
         */
        MXFAsset (std::string directory, std::string file_name, sigc::signal1<void, float>* progress, int fps, int entry_point, int length);

diff --git a/src/picture_asset.h b/src/picture_asset.h
index ae45798439aeb21820aed6450f20b6f5bcac72db..1e99fa92fada86a08b384198a7f1a9bee8fc4bc8 100644 (file)
--- a/src/picture_asset.h
+++ b/src/picture_asset.h
@@ -58,6 +58,7 @@ protected:
        int _height;
 };
 
+/** A 2D (monoscopic) picture asset */
 class MonoPictureAsset : public PictureAsset
 {
 public:
@@ -114,6 +115,7 @@ private:
        void construct (sigc::slot<std::string, int>);
 };
 
+/** A 3D (stereoscopic) picture asset */       
 class StereoPictureAsset : public PictureAsset
 {
 public:

diff --git a/src/picture_frame.cc b/src/picture_frame.cc
index 71a3245c56ecca515475c594ecbc422fb3d8a551..87502e5ea75f3ef4c8e37c57b5d997e01415df12 100644 (file)
--- a/src/picture_frame.cc
+++ b/src/picture_frame.cc
@@ -30,6 +30,10 @@ using namespace std;
 using namespace boost;
 using namespace libdcp;
 
+/** Make a picture frame from a 2D (monoscopic) asset.
+ *  @param mxf_path Path to the asset's MXF file.
+ *  @param n Frame within the asset, not taking EntryPoint into account.
+ */
 MonoPictureFrame::MonoPictureFrame (string mxf_path, int n)
 {
        ASDCP::JP2K::MXFReader reader;
@@ -50,20 +54,6 @@ MonoPictureFrame::~MonoPictureFrame ()
        delete _buffer;
 }
 
-#if 0
-uint8_t const *
-MonoPictureFrame::data () const
-{
-       return _buffer->RoData();
-}
-
-int
-MonoPictureFrame::size () const
-{
-       return _buffer->Size ();
-}
-#endif
-
 /** @return An ARGB representation of this frame.  This is ARGB in the
  *  Cairo sense, so that each pixel takes up 4 bytes; the first byte
  *  is blue, second green, third red and fourth alpha (always 255).
@@ -78,7 +68,10 @@ MonoPictureFrame::argb_frame () const
        return f;
 }
 
-
+/** Make a picture frame from a 3D (stereoscopic) asset.
+ *  @param mxf_path Path to the asset's MXF file.
+ *  @param n Frame within the asset, not taking EntryPoint into account.
+ */
 StereoPictureFrame::StereoPictureFrame (string mxf_path, int n)
 {
        ASDCP::JP2K::MXFSReader reader;
@@ -99,6 +92,13 @@ StereoPictureFrame::~StereoPictureFrame ()
        delete _buffer;
 }
 
+/** @return An ARGB representation of one of the eyes (left or right)
+ *  of this frame.  This is ARGB in the Cairo sense, so that each
+ *  pixel takes up 4 bytes; the first byte is blue, second green,
+ *  third red and fourth alpha (always 255).
+ *
+ *  @param eye Eye to return (EYE_LEFT or EYE_RIGHT).
+ */
 shared_ptr<ARGBFrame>
 StereoPictureFrame::argb_frame (Eye eye) const
 {

diff --git a/src/picture_frame.h b/src/picture_frame.h
index b2693f49e087dc6087dd60ad550679520dbd8455..d207333a88f68260d48d50a151d1b3b11563023a 100644 (file)
--- a/src/picture_frame.h
+++ b/src/picture_frame.h
@@ -33,6 +33,7 @@ namespace libdcp {
 
 class ARGBFrame;
 
+/** A single frame of a 2D (monoscopic) picture asset */       
 class MonoPictureFrame
 {
 public:
@@ -45,6 +46,7 @@ private:
        ASDCP::JP2K::FrameBuffer* _buffer;
 };
 
+/** A single frame of a 3D (stereoscopic) picture asset */     
 class StereoPictureFrame
 {
 public: