Skip to content

Commit

Permalink
fix wrong doxygen comments
Browse files Browse the repository at this point in the history
  • Loading branch information
FAlbertDev committed Sep 27, 2023
1 parent ed45402 commit 9516b5c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
5 changes: 1 addition & 4 deletions src/lib/pubkey/hss_lms/hss.h
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,6 @@ class BOTAN_TEST_API HSS_LMS_PrivateKeyInternal final {
*
* @param hss_params The HSS-LMS parameters for the key.
* @param rng The rng to use.
* @return The internal HSS-LMS private key.
*/
HSS_LMS_PrivateKeyInternal(const HSS_LMS_Params& hss_params, RandomNumberGenerator& rng);

Expand Down Expand Up @@ -171,8 +170,6 @@ class BOTAN_TEST_API HSS_LMS_PrivateKeyInternal final {
* if applications create multiple signatures in one go.
*
* @param msg The message to sign.
* @param rng The rng to use.
* @return The HSS-LMS signature.
*/
secure_vector<uint8_t> sign(std::span<const uint8_t> msg);

Expand Down Expand Up @@ -215,7 +212,7 @@ class BOTAN_TEST_API HSS_LMS_PrivateKeyInternal final {
*
* We use the same generation as the reference implementation (https://github.com/cisco/hash-sigs).
*
* @param child_lms_params The LMS parameters of the child tree.
* @param child_lms_lmots_params The LMS-LMOTS parameter pair of the child tree.
* @param parent_sk The parent's LMS private key
* @param parent_q The LMS leaf number the child tree has in its parent tree.
* @return LMS private key
Expand Down
2 changes: 1 addition & 1 deletion src/lib/pubkey/hss_lms/lms.h
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ class BOTAN_TEST_API LMS_PublicKey : public LMS_Instance {
/**
* @brief Parse a public LMS key.
*
* @param key_bytes The public key bytes to parse.
* @param slicer The BufferSlicer at the public key bytes' position
* @return The LMS public key.
* @throws Decoding_Error If parsing the public key fails.
*/
Expand Down
3 changes: 3 additions & 0 deletions src/scripts/dev_tools/run_clang_tidy.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
'cert-*',
'clang-analyzer-*',
'cppcoreguidelines-*',
'clang-diagnostic-*',
'hicpp-*',
'misc-*',
'modernize-*',
Expand All @@ -46,6 +47,7 @@
'bugprone-lambda-function-name', # should be an easy fix
'bugprone-unchecked-optional-access', # clang-tidy seems buggy (many false positives)
'cert-err58-cpp', # many false positives eg __m128i
'cppcoreguidelines-avoid-do-while',
'cppcoreguidelines-init-variables',
'cppcoreguidelines-owning-memory',
'cppcoreguidelines-prefer-member-initializer',
Expand Down Expand Up @@ -91,6 +93,7 @@
'hicpp-vararg', # idiocy
'hicpp-signed-bitwise', # impossible to avoid in C/C++, int promotion rules :/
'misc-no-recursion',
'misc-include-cleaner',
'modernize-loop-convert', # sometimes very ugly
'modernize-raw-string-literal', # usually less readable
'modernize-use-trailing-return-type', # fine, but we're not using it everywhere
Expand Down

0 comments on commit 9516b5c

Please sign in to comment.