From 3b85a8071f4d7238088834b4924af79b57cb36d1 Mon Sep 17 00:00:00 2001
From: Sadie Powell <sadie@witchery.services>
Date: Sun, 10 Mar 2024 15:58:58 +0000
Subject: Add some missing documentation comments.

---
 include/modules/encryption.h | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'include/modules')

diff --git a/include/modules/encryption.h b/include/modules/encryption.h
index 71d35044a..b8ec8ff58 100644
--- a/include/modules/encryption.h
+++ b/include/modules/encryption.h
@@ -72,6 +72,7 @@ namespace Encryption
 		/** Creates a new encryption context. */
 		virtual std::unique_ptr<Context> CreateContext() = 0;
 
+		/** Quickly encrypts the specified values and returns the digest. */
 		template<typename... Args>
 		Anope::string Encrypt(Args &&...args)
 		{
@@ -80,6 +81,7 @@ namespace Encryption
 			return context->Finalize();
 		}
 
+		/** Calculates the  RFC 2104 hash-based message authentication code for the specified data. */
 		inline Anope::string HMAC(const Anope::string &key, const Anope::string &data)
 		{
 			if (!block_size)
-- 
cgit