Skip to content

Commit 228d39e

Browse files
committed
Settle the documentation of the iterators
We choose to hide the iterator type definitions and just document their category, which is enough.
1 parent 09b7ca2 commit 228d39e

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

doc/mrdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ cmake: '-DDYNAMIC_BITSET_MRDOCS_BUILD=ON'
1212
input:
1313
- ../include
1414
exclude-symbols:
15+
- 'boost::bit_iterator_base'
16+
- 'boost::bit_iterator'
17+
- 'boost::const_bit_iterator'
1518
- 'boost::detail'
1619
- 'boost::detail::**'
1720
- 'boost::to_string_helper'

include/boost/dynamic_bitset/dynamic_bitset.hpp

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,10 +271,19 @@ class dynamic_bitset
271271
friend class const_bit_iterator< dynamic_bitset >;
272272

273273
//! A read/write iterator into the bitset.
274+
//!
275+
//! If `AllocatorOrContainer` is an allocator type, this is a
276+
//! C++20 RandomAccessIterator; otherwise, its category is the
277+
//! corresponding "non-legacy" category of the iterator type of
278+
//! the underlying container; for instance, if the underlying
279+
//! container provides LegacyBidirectionalIterators, this is a
280+
//! BidirectionalIterator.
274281
// -----------------------------------------------------------------------
275282
typedef bit_iterator< dynamic_bitset > iterator;
276283

277284
//! A read-only iterator into the bitset.
285+
//!
286+
//! \copydetails iterator
278287
// -----------------------------------------------------------------------
279288
typedef const_bit_iterator< dynamic_bitset > const_iterator;
280289

0 commit comments

Comments
 (0)