Browse Source

[trac781] document exceptions

Jelte Jansen 14 years ago
parent
commit
a7c4e0bc10
1 changed files with 6 additions and 1 deletions
  1. 6 1
      src/lib/crypto/crypto.h

+ 6 - 1
src/lib/crypto/crypto.h

@@ -36,19 +36,24 @@
 namespace isc {
 namespace crypto {
 
+/// General exception class that is the base for all crypto-related
+/// exceptions
 class CryptoError : public Exception {
 public:
     CryptoError(const char* file, size_t line, const char* what) :
         isc::Exception(file, line, what) {}
 };
 
+/// This exception is thrown when a cryptographic action is requested
+/// for an algorithm that is not supported by the underlying algorithm.
 class UnsupportedAlgorithm : public CryptoError {
 public:
     UnsupportedAlgorithm(const char* file, size_t line, const char* what) :
         CryptoError(file, line, what) {}
 };
 
-// The underlying library could not handle this key
+/// This exception is thrown when the underlying library could not
+/// handle this key
 class BadKey : public CryptoError {
 public:
     BadKey(const char* file, size_t line, const char* what) :