Improved XMLDOC regarding exceptions and TFormat_HEX.DoDecode and TFormat_UU.Decode throw an EDECFormatException instead of an EDECException now if data is passed in a wrong format.

Author: MHumm

Source/DECBaseClass.pas

@@ -84,6 +84,9 @@   TDECClassList = class(TDictionary<Int64, TDECClass>)
     ///   Returns the class type if found. if it could not be found a
     ///   EDECClassNotRegisteredException will be thrown
     /// </returns>
+    /// <exception cref="EDECClassNotRegisteredException">
+    ///   Exception raised if the class specified by <c>Name</c> is not found
+    /// </exception>
     function ClassByName(const Name: string): TDECClass;
 
     /// <summary>
@@ -99,6 +102,9 @@   TDECClassList = class(TDictionary<Int64, TDECClass>)
     ///   or throws an EDECClassNotRegisteredException exception if no class
     ///   with the given identity has been found
     /// </returns>
+    /// <exception cref="EDECClassNotRegisteredException">
+    ///   Exception raised if the class specified by <c>Identity</c> is not found
+    /// </exception>
     function ClassByIdentity(Identity: Int64): TDECClass;
     /// <summary>
     ///   Returns a list of all classes registered in this list

Source/DECCipherBase.pas

@@ -308,6 +308,10 @@   TDECCipher = class(TDECObject)
     /// <param name="States">
     ///   List of states the state machine should be at currently
     /// </param>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the state machine is not in one of the states
+    ///   specified by the <c>States</c> parameter.
+    /// </exception>
     procedure CheckState(States: TCipherStates);
 
     /// <summary>
@@ -399,6 +403,9 @@   TDECCipher = class(TDECObject)
     ///   Returns the class type if found. if it could not be found a
     ///   EDECClassNotRegisteredException will be thrown
     /// </returns>
+    /// <exception cref="EDECClassNotRegisteredException">
+    ///   Exception raised if the class specified by <c>Name</c> is not found
+    /// </exception>
     class function ClassByName(const Name: string): TDECCipherClass;
 
     /// <summary>
@@ -414,6 +421,9 @@   TDECCipher = class(TDECObject)
     ///   or throws an EDECClassNotRegisteredException exception if no class
     ///   with the given identity has been found
     /// </returns>
+    /// <exception cref="EDECClassNotRegisteredException">
+    ///   Exception raised if the class specified by <c>Identity</c> is not found
+    /// </exception>
     class function ClassByIdentity(Identity: Int64): TDECCipherClass;
 
     /// <summary>
@@ -600,6 +610,10 @@   TDECCipher = class(TDECObject)
     /// <returns>
     ///   Encrypted data. Init must have been called previously.
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeRawByteString(const Source: RawByteString;
                                  Format: TDECFormatClass = nil): RawByteString;
                                  deprecated; // please use EncodeBytes functions now
@@ -629,6 +643,10 @@   TDECCipher = class(TDECObject)
     /// <returns>
     ///   Decrypted data. Init must have been called previously.
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeRawByteString(const Source: RawByteString;
                                  Format: TDECFormatClass = nil): RawByteString; deprecated; // please use DecodeBytes functions now
 
@@ -649,6 +667,10 @@   TDECCipher = class(TDECObject)
     /// <returns>
     ///   Encrypted data. Init must have been called previously.
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeBytes(const Source: TBytes; Format: TDECFormatClass = nil): TBytes;
     /// <summary>
     ///   Decrypts the contents of a ByteArray.
@@ -669,6 +691,10 @@   TDECCipher = class(TDECObject)
     /// <returns>
     ///   Decrypted data. Init must have been called previously.
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeBytes(const Source: TBytes; Format: TDECFormatClass): TBytes;
 
     // CalcMACBytes deferred since the current implementation would neither be

Source/DECCipherFormats.pas

@@ -100,6 +100,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Byte array with encrypted data
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeBytes(const Source: TBytes): TBytes;
 
     /// <summary>
@@ -114,6 +118,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Byte array with decrypted data
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeBytes(const Source: TBytes): TBytes;
 
     /// <summary>
@@ -134,6 +142,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <param name="OnProgress">
     ///   optional callback for reporting progress of the operation
     /// </param>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     procedure EncodeStream(const Source, Dest: TStream; DataSize: Int64;
                            const OnProgress: TDECProgressEvent = nil);
 
@@ -155,6 +167,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <param name="OnProgress">
     ///   optional callback for reporting progress of the operation
     /// </param>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     procedure DecodeStream(const Source, Dest: TStream; DataSize: Int64;
                            const OnProgress: TDECProgressEvent = nil);
 
@@ -174,6 +190,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   Optional event which can be passed to get information about the
     ///   progress of the encryption operation
     /// </param>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     procedure EncodeFile(const SourceFileName, DestFileName: string;
                          const OnProgress: TDECProgressEvent = nil);
 
@@ -193,6 +213,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   Optional event which can be passed to get information about the
     ///   progress of the decryption operation
     /// </param>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     procedure DecodeFile(const SourceFileName, DestFileName: string;
                          const OnProgress: TDECProgressEvent = nil);
 
@@ -215,6 +239,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Encrypted string as a byte array
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeStringToBytes(const Source: string;
                                  Format: TDECFormatClass = nil): TBytes; overload;
 
@@ -237,6 +265,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Encrypted string as a byte array
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeStringToBytes(const Source: RawByteString;
                                  Format: TDECFormatClass = nil): TBytes; overload;
 
@@ -266,6 +298,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   byte combinations in a destructive way, making the encrypted string
     ///   un-decryptable.
     /// </remarks>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeStringToString(const Source: string;
                                   Format: TDECFormatClass = nil): string; overload;
 
@@ -295,6 +331,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   byte combinations in a destructive way, making the encrypted string
     ///   un-decryptable.
     /// </remarks>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeStringToString(const Source: RawByteString;
                                   Format: TDECFormatClass = nil): RawByteString; overload;
 
@@ -317,6 +357,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Decrypted string as a byte array
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeStringToBytes(const Source: string;
                                  Format: TDECFormatClass = nil): TBytes; overload;
 
@@ -339,6 +383,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Decrypted string as a byte array
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeStringToBytes(const Source: RawByteString;
                                  Format: TDECFormatClass = nil): TBytes; overload;
 
@@ -366,6 +414,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   which uses an 7-bit ASCII compatible string as input so that it
     ///   didn't get altered by Unicode string processing in some hafrmful way
     /// </remarks>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeStringToString(const Source: string;
                                   Format: TDECFormatClass = nil): string; overload;
 
@@ -393,6 +445,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   which uses an 7-bit ASCII compatible string as input so that it
     ///   didn't get altered by string processing in some hafrmful way
     /// </remarks>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeStringToString(const Source: RawByteString;
                                   Format: TDECFormatClass = nil): RawByteString; overload;
 
@@ -416,6 +472,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Encrypted string as a byte array
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeStringToBytes(const Source: AnsiString;
                                  Format: TDECFormatClass = nil): TBytes; overload;
 
@@ -445,6 +505,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   byte combinations in a destructive way, making the encrypted string
     ///   un-decryptable.
     /// </remarks>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeStringToString(const Source: AnsiString;
                                   Format: TDECFormatClass = nil): AnsiString; overload;
 
@@ -467,6 +531,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Decrypted string as a byte array
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeStringToBytes(const Source: AnsiString;
                                  Format: TDECFormatClass = nil): TBytes; overload;
 
@@ -494,6 +562,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   which uses an 7-bit ASCII compatible string as input so that it
     ///   didn't get altered by string processing in some hafrmful way
     /// </remarks>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeStringToString(const Source: AnsiString;
                                   Format: TDECFormatClass = nil): AnsiString; overload;
 {$ENDIF}
@@ -518,6 +590,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Encrypted string as a byte array
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeStringToBytes(const Source: WideString;
                                  Format: TDECFormatClass = nil): TBytes; overload;
 
@@ -547,6 +623,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   byte combinations in a destructive way, making the encrypted string
     ///   un-decryptable.
     /// </remarks>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function EncodeStringToString(const Source: WideString;
                                   Format: TDECFormatClass = nil): WideString; overload;
 
@@ -569,6 +649,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     /// <returns>
     ///   Decrypted string as a byte array
     /// </returns>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeStringToBytes(const Source: WideString;
                                  Format: TDECFormatClass = nil): TBytes; overload;
 
@@ -596,6 +680,10 @@   TDECFormattedCipher = class(TDECCipherModes, IDECCipher)
     ///   which uses an 7-bit ASCII compatible string as input so that it
     ///   didn't get altered by string processing in some hafrmful way
     /// </remarks>
+    /// <exception cref="EDECCipherException">
+    ///   Exception raised if the length of the data passed as <c>Source</c>
+    ///   is not a multiple of the algorithm's block size.
+    /// </exception>
     function DecodeStringToString(const Source: WideString;
                                   Format: TDECFormatClass = nil): WideString; overload;
 {$ENDIF}