Rename mxf filename ignoring stuff slightly.

[libdcp.git] / src / sound_frame.h

diff --git a/src/sound_frame.h b/src/sound_frame.h
index e7b13885c9b1e5fc3691e9c5136e1b7ae478cb61..26f738d3524c72156a51221864b3d0d6bb20d44c 100644 (file)
--- a/src/sound_frame.h
+++ b/src/sound_frame.h
@@ -17,10 +17,15 @@
 
 */
 
+/** @file  src/sound_frame.h
+ *  @brief SoundFrame class.
+ */
+
 #ifndef LIBDCP_SOUND_FRAME_H
 #define LIBDCP_SOUND_FRAME_H
 
 #include <boost/noncopyable.hpp>
+#include <boost/filesystem.hpp>
 #include <stdint.h>
 #include <string>
 
@@ -33,16 +38,20 @@ namespace ASDCP {
 
 namespace dcp {
 
+/** @class SoundFrame
+ *  @brief One &lsquo;frame&rsquo; of sound data from a MXF.
+ */
 class SoundFrame : public boost::noncopyable
 {
 public:
-       SoundFrame (std::string mxf_path, int n, ASDCP::AESDecContext *);
+       SoundFrame (boost::filesystem::path mxf_path, int n, ASDCP::AESDecContext *);
        ~SoundFrame ();
 
        uint8_t const * data () const;
        int size () const;
 
 private:
+       /** a buffer to hold the frame */
        ASDCP::PCM::FrameBuffer* _buffer;
 };