From 26dac17a4ab86695cacffeb2ca9aaa429fe67759 Mon Sep 17 00:00:00 2001 From: Gennaro Prota Date: Mon, 15 Sep 2025 11:21:27 +0200 Subject: [PATCH] Settle the documentation of the iterators We choose to hide the iterator type definitions and just document their category, which is enough. --- doc/mrdocs.yml | 3 +++ include/boost/dynamic_bitset/dynamic_bitset.hpp | 9 +++++++++ 2 files changed, 12 insertions(+) diff --git a/doc/mrdocs.yml b/doc/mrdocs.yml index cb66015..71ec28f 100644 --- a/doc/mrdocs.yml +++ b/doc/mrdocs.yml @@ -12,6 +12,9 @@ cmake: '-DDYNAMIC_BITSET_MRDOCS_BUILD=ON' input: - ../include exclude-symbols: + - 'boost::bit_iterator_base' + - 'boost::bit_iterator' + - 'boost::const_bit_iterator' - 'boost::detail' - 'boost::detail::**' - 'boost::to_string_helper' diff --git a/include/boost/dynamic_bitset/dynamic_bitset.hpp b/include/boost/dynamic_bitset/dynamic_bitset.hpp index be98ede..e275c4d 100644 --- a/include/boost/dynamic_bitset/dynamic_bitset.hpp +++ b/include/boost/dynamic_bitset/dynamic_bitset.hpp @@ -271,10 +271,19 @@ public: friend class const_bit_iterator< dynamic_bitset >; //! A read/write iterator into the bitset. + //! + //! If `AllocatorOrContainer` is an allocator type, this is a + //! C++20 RandomAccessIterator; otherwise, its category is the + //! corresponding "non-legacy" category of the iterator type of + //! the underlying container; for instance, if the underlying + //! container provides LegacyBidirectionalIterators, this is a + //! BidirectionalIterator. // ----------------------------------------------------------------------- typedef bit_iterator< dynamic_bitset > iterator; //! A read-only iterator into the bitset. + //! + //! \copydetails iterator // ----------------------------------------------------------------------- typedef const_bit_iterator< dynamic_bitset > const_iterator;