Some OS X build fixes.
[libdcp.git] / src / file.h
index f2b992091d4e76d8c444e4b45afd92a1052a2d2e..8d98599f6ce2859087e57c3c5cf111522cf42ba2 100644 (file)
 
 */
 
+/** @file  src/file.h
+ *  @brief File class.
+ */
+
+#ifndef LIBDCP_FILE_H
+#define LIBDCP_FILE_H
+
 #include <boost/filesystem.hpp>
+#include <boost/noncopyable.hpp>
 
 namespace dcp {
 
-class File
+/** @class File
+ *  @brief Helper class which loads a file into memory.
+ */
+class File : public boost::noncopyable
 {
 public:
        File (boost::filesystem::path file);
        ~File ();
-       
+
        uint8_t* data () const {
                return _data;
        }
@@ -36,8 +47,10 @@ public:
        }
 
 private:
-       uint8_t* _data;
-       int64_t _size;
+       uint8_t* _data; ///< file's data
+       int64_t _size;  ///< data size in bytes
 };
 
 }
+
+#endif