diff options
| author | Carl Hetherington <cth@carlh.net> | 2013-09-25 18:02:31 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2013-09-25 18:02:31 +0100 |
| commit | e8530ea06f0b0883e5e19dd18beed70732ac5d3c (patch) | |
| tree | 37b23fd854ab222a9c02163e655c52fa503804a3 /src/key.h | |
| parent | e563727ee7b72881ee163db9b777559c8ceb5074 (diff) | |
Some comments.
Diffstat (limited to 'src/key.h')
| -rw-r--r-- | src/key.h | 12 |
1 files changed, 10 insertions, 2 deletions
@@ -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: |
