From f9862aff32f7ea5aa10f9362d7598480b1c9cf28 Mon Sep 17 00:00:00 2001
From: Carl Hetherington <cth@carlh.net>
Date: Wed, 5 Feb 2014 12:59:12 +0000
Subject: Comments / tweaks.

---
 src/file.h | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

(limited to 'src/file.h')

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
-- 
cgit v1.2.3