Some comments.

[libdcp.git] / src / exceptions.h

diff --git a/src/exceptions.h b/src/exceptions.h
index 9b2617eee3d7c85d1b39595ffbc1d09dad177233..e613c980d037c872d52177b24499d77a6b1c2cba 100644 (file)
--- a/src/exceptions.h
+++ b/src/exceptions.h
@@ -29,6 +29,9 @@
 namespace dcp
 {
 
+/** @class StringError
+ *  @brief An exception that uses a std::string to store its error message.
+ */
 class StringError : public std::exception
 {
 public:
@@ -159,13 +162,20 @@ public:
        TimeFormatError (std::string bad_time);
 };
 
+/** @class NotEncryptedError
+ *  @brief An error raised when creating a DecryptedKDM object for assets that are not
+ *  encrypted.
+ */
 class NotEncryptedError : public StringError
 {
 public:
        NotEncryptedError (std::string const & what);
        ~NotEncryptedError () throw () {}
 };
-       
+
+/** @class ProgrammingError
+ *  @brief An exception thrown when a DCP_ASSERT fails; something that should not happen.
+ */
 class ProgrammingError : public StringError
 {
 public: