Comments / tweaks.

[libdcp.git] / src / file.h

diff --git a/src/file.h b/src/file.h
index f2b992091d4e76d8c444e4b45afd92a1052a2d2e..b06cece00fa09655f3d6e16eb438f904a8f04325 100644 (file)
--- a/src/file.h
+++ b/src/file.h
@@ -17,10 +17,20 @@
 
 */
 
+/** @file  src/file.h
+ *  @brief File class.
+ */
+
+#ifndef LIBDCP_FILE_H
+#define LIBDCP_FILE_H
+
 #include <boost/filesystem.hpp>
 
 namespace dcp {
 
+/** @class File
+ *  @brief Helper class which loads a file into memory.
+ */
 class File
 {
 public:
@@ -36,8 +46,10 @@ public:
        }
 
 private:
-       uint8_t* _data;
-       int64_t _size;
+       uint8_t* _data; ///< file's data
+       int64_t _size;  ///< data size in bytes
 };
 
 }
+
+#endif