From fb416ca901c66d67e42f97232f6191626abdb72d Mon Sep 17 00:00:00 2001 From: Anton Karpov Date: Thu, 6 Aug 2026 09:10:51 +0300 Subject: [PATCH] Document the two parameters BitFieldsToString takes The @param line was copied from BitFieldToString above it and still names a single field. BitFieldsToString takes bits and count, so Doxygen drops the entry and both parameters render undocumented. clang -Wdocumentation on bitset_utils.hpp: one warning before, none after. Human manager: @karpovantonme Docstring drafted with Claude Opus, per doc/dev/ai-usage-guidelines.md --- include/emp/bits/bitset_utils.hpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/emp/bits/bitset_utils.hpp b/include/emp/bits/bitset_utils.hpp index 61389e39b..d8a3ba3d9 100644 --- a/include/emp/bits/bitset_utils.hpp +++ b/include/emp/bits/bitset_utils.hpp @@ -43,7 +43,8 @@ namespace emp { } /// @brief Convert a series of bit fields to a string. - /// @param field A single bit field to convert to a string. + /// @param bits The bit fields to convert to a string. + /// @param count How many bit fields to read. [[maybe_unused]] [[nodiscard]] std::string BitFieldsToString(bits_field_t * bits, size_t count) { std::stringstream ss; for (size_t i = 0; i < count; ++i) {