Doxygen

1 files changed, 10 insertions, 2 deletions

diff --git a/src/constructs/fpe/fpe.h b/src/constructs/fpe/fpe.h
index 75f90247f..7a4a7861a 100644
--- a/src/constructs/fpe/fpe.h
+++ b/src/constructs/fpe/fpe.h
@@ -13,15 +13,23 @@
 
 namespace Botan {
 
-/*
+/**
 * Encrypt X from and onto the group Z_n using key and tweak
+* @param n the modulus
+* @param X the plaintext as a BigInt
+* @param key a random key
+* @param tweak will modify the ciphertext (think of as an IV)
 */
 BigInt BOTAN_DLL fpe_encrypt(const BigInt& n, const BigInt& X,
                              const SymmetricKey& key,
                              const MemoryRegion<byte>& tweak);
 
-/*
+/**
 * Decrypt X from and onto the group Z_n using key and tweak
+* @param n the modulus
+* @param X the ciphertext as a BigInt
+* @param key is the key used for encryption
+* @param tweak the same tweak used for encryption
 */
 BigInt BOTAN_DLL fpe_decrypt(const BigInt& n, const BigInt& X,
                              const SymmetricKey& key,