Skip to content

Commit f7a0542

Browse files
committed
Improve documentation of signing-related API
1 parent df5e111 commit f7a0542

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

misc/signingkeys.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ namespace CppUtilities {
1717
* - The concrete type of the contained key variables will change when the number of keys changes.
1818
* So do *not* use it in e.g. a function signature or member variable that will become part of
1919
* some public API/ABI. The variable is mereley supposed to be passed to verifySignature().
20-
* - This function is experimental and might be changed in incompatible ways (API and ABI wise) or be completely removed
21-
* in further minor/patch releases.
20+
* - This namespace is experimental and its members might be changed in incompatible ways (API and ABI
21+
* wise) or be completely removed in further minor/patch releases.
2222
*/
2323
namespace SigningKeys {
2424

misc/verification.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ inline std::string extractPemBody(std::string_view pem, std::string_view header)
5151
return body;
5252
}
5353

54-
/// \brief Converts PEM-encoded signature into DER-encoded signature.
54+
/// \brief Converts a PEM-encoded signature into a DER-encoded signature.
5555
/// \remarks This function is an implementation detail and must not be called by users of this library.
5656
inline std::string parsePemSignature(std::string_view pemSignature, std::pair<std::unique_ptr<std::uint8_t[]>, std::uint32_t> &decodedSignature)
5757
{

0 commit comments

Comments
 (0)