Skip to content

Commit 40b0964

Browse files
committed
Fix doxygen warnings which were failing the CI.
1 parent dbc0d66 commit 40b0964

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

Doxyfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,9 @@ TAB_SIZE = 2
229229
# newlines.
230230

231231
ALIASES = "errors=@par Errors returnable\n" "mallocs=@par Memory Allocations\n" \
232-
"raceguarantees{1}=@par Race Guarantees\n\1" \
233-
"complexity{1}=@par Complexity\n\1" \
234-
"exceptionmodel{1}=@par Errors returnable\n\1"
232+
"raceguarantees{1}=@par Race Guarantees^^\1" \
233+
"complexity{1}=@par Complexity^^\1" \
234+
"exceptionmodel{1}=@par Errors returnable^^\1"
235235

236236
# This tag can be used to specify a number of word-keyword mappings (TCL only).
237237
# A mapping has the form "name=value". For example adding "class=itcl::class"

include/quickcpplib/algorithm/bit_interleave.hpp

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Distributed under the Boost Software License, Version 1.0.
3030
#include <cstdint>
3131
#include <type_traits>
3232

33-
#if 0 //defined(__AVX__) || defined(__SSE4_1__) || defined(__SSSE3__)
33+
#if 0 // defined(__AVX__) || defined(__SSE4_1__) || defined(__SSSE3__)
3434
#include <tmmintrin.h> // for _mm_shuffle_epi8
3535
#endif
3636

@@ -86,7 +86,7 @@ namespace algorithm
8686
#pragma warning(disable : 4310) // cast truncates constant value
8787
#pragma warning(disable : 4333) // right shift by too large amount
8888
#endif
89-
/*! \brief Interleaves the bits of \emph a and \emph b.
89+
/*! \brief Interleaves the bits of \em a and \em b.
9090
9191
On my Intel i7-8565u laptop able to boost to 4.6Ghz:
9292
@@ -97,7 +97,7 @@ namespace algorithm
9797
QUICKCPPLIB_TREQUIRES(QUICKCPPLIB_TPRED(std::is_unsigned<T>::value))
9898
inline R bit_interleave(T a, T b) noexcept
9999
{
100-
#if 0 // defined(__AVX__) || defined(__SSE4_1__) || defined(__SSSE3__)
100+
#if 0 // defined(__AVX__) || defined(__SSE4_1__) || defined(__SSSE3__)
101101
/* https://lemire.me/blog/2018/01/09/how-fast-can-you-bit-interleave-32-bit-integers-simd-edition/
102102
says that AVX is considerably faster than the SSSE3 bit interleave if you need to interleave two 128
103103
bit values into a 256 bit value, but we don't support that here yet.
@@ -141,9 +141,10 @@ namespace algorithm
141141
inline bit_deinterleave_result<R> bit_deinterleave(T x) noexcept
142142
{
143143
constexpr T /* mask32 = T(0x00000000ffffffff), */ mask16 = T(0x0000ffff0000ffff),
144-
mask8 = T(0x00ff00ff00ff00ff) /* 0000 0000 1111 1111 */,
145-
mask4 = T(0x0f0f0f0f0f0f0f0f) /* 0000 1111 */, mask2 = T(0x3333333333333333) /* 0011 0011 */,
146-
mask1 = T(0x5555555555555555) /* 0101 0101 */;
144+
mask8 = T(0x00ff00ff00ff00ff) /* 0000 0000 1111 1111 */,
145+
mask4 = T(0x0f0f0f0f0f0f0f0f) /* 0000 1111 */,
146+
mask2 = T(0x3333333333333333) /* 0011 0011 */,
147+
mask1 = T(0x5555555555555555) /* 0101 0101 */;
147148
T ret1 = x & mask1, ret2 = (x >> 1) & mask1;
148149
ret1 = (ret1 ^ (ret1 >> 1)) & mask2;
149150
ret2 = (ret2 ^ (ret2 >> 1)) & mask2;

include/quickcpplib/revision.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
// Note the second line of this file must ALWAYS be the git SHA, third line ALWAYS the git SHA update time
2-
#define QUICKCPPLIB_PREVIOUS_COMMIT_REF 659f470cec041df6c7d74c5786d9c518dc42263e
3-
#define QUICKCPPLIB_PREVIOUS_COMMIT_DATE "2025-07-09 14:47:44 +00:00"
4-
#define QUICKCPPLIB_PREVIOUS_COMMIT_UNIQUE 659f470c
2+
#define QUICKCPPLIB_PREVIOUS_COMMIT_REF dbc0d662c801806acb2341308217f596fa80d20a
3+
#define QUICKCPPLIB_PREVIOUS_COMMIT_DATE "2025-12-16 17:25:20 +00:00"
4+
#define QUICKCPPLIB_PREVIOUS_COMMIT_UNIQUE dbc0d662

include/quickcpplib/signal_guard.hpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -628,8 +628,7 @@ namespace signal_guard
628628
`true` if execution is to resume, `false` if the next decider function should be called.
629629
Note that on Windows only, `signalc::interrupt` and `signalc::process_terminate` call `f` from some other
630630
kernel thread, and the return value is always treated as `false`.
631-
\param callfirst True if this decider should be called before any other. Otherwise
632-
call order is in the order of addition.
631+
\param ms The number of milliseconds before invoking the callable.
633632
*/
634633
QUICKCPPLIB_TEMPLATE(class U)
635634
QUICKCPPLIB_TREQUIRES(QUICKCPPLIB_TPRED(std::is_constructible<T, U>::value), QUICKCPPLIB_TEXPR(std::declval<U>()()))

0 commit comments

Comments
 (0)