Skip to content

docs: refine Doxygen comments in headers #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LimiNode merged 2 commits into from
Sep 5, 2025
Merged

docs: refine Doxygen comments in headers #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f7c316
docs(doxygen): refine header comments
LimiNode Sep 5, 2025
6d6ab48
Merge branch 'main' into codex/normalize-doxygen-comments-in-hmac_cpp
LimiNode Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion include/hmac_cpp/hmac.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,11 @@ namespace hmac_cpp {
}

/// \brief Streaming HMAC computation context.
/// \thread_safety Not thread-safe.
class HMAC_CPP_API HmacContext {
public:
/// \brief Construct context for selected hash.
/// \param type Hash function type.
explicit HmacContext(TypeHash type) : type_(type), block_size_(0), digest_size_(0) {}

/// \brief Initializes the context with a secret key.
Expand Down Expand Up @@ -114,17 +117,31 @@ namespace hmac_cpp {
/// \return HMAC result
HMAC_CPP_API std::string get_hmac(const std::vector<uint8_t>& key, const std::string &msg, TypeHash type, bool is_hex = true, bool is_upper = false);

/// \brief Computes HMAC from secure_buffer key
/// \brief Compute HMAC using secure_buffer key.
/// \param key Secret key bytes.
/// \param msg Message to authenticate.
/// \param type Hash function type.
/// \param is_hex Return result in hex format.
/// \param is_upper Use uppercase hex.
/// \return HMAC result.
inline std::string get_hmac(const secure_buffer<uint8_t>& key, const std::string &msg, TypeHash type, bool is_hex = true, bool is_upper = false) {
return get_hmac(std::vector<uint8_t>(key.begin(), key.end()), msg, type, is_hex, is_upper);
}

/// \brief Compute HMAC using string key.
/// \param key_input Secret key as string.
/// \param msg Message to authenticate.
/// \param type Hash function type.
/// \param is_hex Return result in hex format.
/// \param is_upper Use uppercase hex.
/// \return HMAC result.
/// \deprecated Prefer overloads that accept std::vector<uint8_t> or secure_buffer.
HMACCPP_DEPRECATED("use std::vector<uint8_t> or secure_buffer overload")
inline std::string get_hmac(const std::string& key_input, const std::string &msg, TypeHash type, bool is_hex = true, bool is_upper = false) {
return get_hmac(std::vector<uint8_t>(key_input.begin(), key_input.end()), msg, type, is_hex, is_upper);
}
}

namespace hmac = hmac_cpp;

#endif // _HMAC_HPP_INCLUDED
Loading
Loading