X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Ffile.h;h=b06cece00fa09655f3d6e16eb438f904a8f04325;hb=f9862aff32f7ea5aa10f9362d7598480b1c9cf28;hp=f2b992091d4e76d8c444e4b45afd92a1052a2d2e;hpb=9acb2e83ed4a39ece8d39dd479c160b79b02d7ab;p=libdcp.git 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 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