From 5043e6cf4ea537dfe599470797c5b310ab0e94b9 Mon Sep 17 00:00:00 2001
From: Yueh-Shun Li <shamrocklee@posteo.net>
Date: Wed, 18 Oct 2023 17:08:06 +0800
Subject: [PATCH] Document HashFormat

---
 src/libutil/hash.hh | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/src/libutil/hash.hh b/src/libutil/hash.hh
index 73c2183ef..0db9bcd6d 100644
--- a/src/libutil/hash.hh
+++ b/src/libutil/hash.hh
@@ -23,7 +23,21 @@ extern std::set<std::string> hashTypes;
 
 extern const std::string base32Chars;
 
-enum HashFormat : int { Base64, Base32, Base16, SRI };
+/**
+ * @brief Enumeration representing the hash formats.
+ */
+enum HashFormat : int {
+    /// @brief Base 64 encoding.
+    /// @see [IETF RFC 4648, section 4](https://datatracker.ietf.org/doc/html/rfc4648#section-4).
+    Base64,
+    /// @brief Nix-specific base-32 encoding. @see base32Chars
+    Base32,
+    /// @brief Lowercase hexadecimal encoding. @see base16Chars
+    Base16,
+    /// @brief "<hash algo>:<Base 64 hash>", format of the SRI integrity attribute.
+    /// @see W3C recommendation [Subresource Intergrity](https://www.w3.org/TR/SRI/).
+    SRI
+};
 
 
 struct Hash