Skip to content

Commit 66690c4

Browse files
committed
Merge branch 'develop' into experiments/antora
2 parents 224c1cf + e475e30 commit 66690c4

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

include/boost/dynamic_bitset/dynamic_bitset.hpp

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -460,8 +460,9 @@ class dynamic_bitset
460460
// -----------------------------------------------------------------------
461461
allocator_type get_allocator() const;
462462

463-
//! Changes the number of bits of the bitset to `num_bits`. If
464-
//! `num_bits >= size()` then the bits in the range `[0,
463+
//! Changes the number of bits of the bitset to `num_bits`.
464+
//!
465+
//! If `num_bits >= size()` then the bits in the range `[0,
465466
//! size())` remain the same, and the bits in `[size(),
466467
//! num_bits]` are all set to `value`. If `num_bits < size()`
467468
//! then the bits in the range `[0, num_bits)` stay the same
@@ -593,6 +594,7 @@ class dynamic_bitset
593594
dynamic_bitset & operator-=( const dynamic_bitset & b );
594595

595596
//! Shifts the bits in this bitset to the left by `n` positions.
597+
//!
596598
//! For each bit in the bitset, the bit at position `pos` takes
597599
//! on the previous value of the bit at position `pos - n`, or
598600
//! zero if no such bit exists.
@@ -605,10 +607,12 @@ class dynamic_bitset
605607
// -----------------------------------------------------------------------
606608
dynamic_bitset & operator<<=( size_type n );
607609

608-
//! Shifts the bitset in this bitset to the right by `n`
609-
//! positions. For each bit in the bitset, the bit at position
610-
//! `pos` takes on the previous value of the bit at position
611-
//! `pos + n`, or zero if no such bit exists.
610+
//! Shifts the bits in this bitset to the right by `n`
611+
//! positions.
612+
//!
613+
//! For each bit in the bitset, the bit at position `pos` takes
614+
//! on the previous value of the bit at position `pos + n`, or
615+
//! zero if no such bit exists.
612616
//!
613617
//! \return
614618
//! `*this`.
@@ -916,8 +920,9 @@ class dynamic_bitset
916920
size_type capacity() const BOOST_NOEXCEPT;
917921

918922
//! Informs the bitset of a planned change in size, so that it
919-
//! can manage the storage allocation accordingly. After
920-
//! `reserve()`, `capacity()` is greater or equal to the
923+
//! can manage the storage allocation accordingly.
924+
//!
925+
//! After `reserve()`, `capacity()` is greater or equal to the
921926
//! argument of `reserve()` if reallocation happens; and equal
922927
//! to the previous value of `capacity()` otherwise.
923928
//! Reallocation happens at this point if and only if the
@@ -1360,9 +1365,10 @@ operator-( const dynamic_bitset< Block, Allocator > & a, const dynamic_bitset< B
13601365
template< typename Block, typename Allocator >
13611366
void swap( dynamic_bitset< Block, Allocator > & a, dynamic_bitset< Block, Allocator > & b ) BOOST_NOEXCEPT;
13621367

1363-
//! Copies a representation of `b` into the string `s`. Character
1364-
//! position `i` in the string corresponds to bit position `b.size()
1365-
//! - 1 - i`.
1368+
//! Copies a representation of `b` into the string `s`.
1369+
//!
1370+
//! Character position `i` in the string corresponds to bit position
1371+
//! `b.size() - 1 - i`.
13661372
//!
13671373
//! \par Throws
13681374
//! An allocation error from `s` if memory is exhausted.
@@ -1387,7 +1393,7 @@ to_string( const dynamic_bitset< Block, Allocator > & b, StringT & s );
13871393
//! The first block written represents the bits in the position
13881394
//! range `[0, bits_per_block)` in the bitset, the second block
13891395
//! written the bits in the range `[bits_per_block,
1390-
//! 2*bits_per_block)`, and so on. For each block `bval` written,
1396+
//! 2 * bits_per_block)`, and so on. For each block `bval` written,
13911397
//! the bit `( bval >> i ) & 1` corresponds to the bit at position
13921398
//! `b * bits_per_block + i` in the bitset.
13931399
//!

0 commit comments

Comments
 (0)