From e8530ea06f0b0883e5e19dd18beed70732ac5d3c Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Wed, 25 Sep 2013 18:02:31 +0100 Subject: Some comments. --- src/key.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'src/key.h') diff --git a/src/key.h b/src/key.h index fbadfd33..d0286627 100644 --- a/src/key.h +++ b/src/key.h @@ -17,6 +17,10 @@ */ +/** @file src/key.h + * @brief Class to hold a key for encrypting MXFs. + */ + #ifndef LIBDCP_KEY_H #define LIBDCP_KEY_H @@ -24,7 +28,9 @@ namespace libdcp { -/** A key for encrypting MXFs */ +/** @class Key + * @brief A key for encrypting MXFs. + */ class Key { public: @@ -42,10 +48,12 @@ public: Key& operator= (Key const &); - uint8_t* value () const { + /** @return Raw key value */ + uint8_t const * value () const { return _value; } + /** @return Key value as a hexadecimal string */ std::string hex () const; private: -- cgit v1.2.3