summaryrefslogtreecommitdiff
path: root/src/file.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2014-02-05 12:59:12 +0000
committerCarl Hetherington <cth@carlh.net>2014-02-05 12:59:12 +0000
commitf9862aff32f7ea5aa10f9362d7598480b1c9cf28 (patch)
treedf14985bee0e52f284ffa4c0881a61b32848f5d0 /src/file.h
parent9acb2e83ed4a39ece8d39dd479c160b79b02d7ab (diff)
Comments / tweaks.
Diffstat (limited to 'src/file.h')
-rw-r--r--src/file.h16
1 files changed, 14 insertions, 2 deletions
diff --git a/src/file.h b/src/file.h
index f2b99209..b06cece0 100644
--- 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