boost/dynamic_bitset
2
0
Fork 0
mirror of https://github.com/boostorg/dynamic_bitset.git synced 2026-01-19 04:12:09 +00:00
Code Issues Projects Releases Wiki Activity

Fix a few documentation glitches

Browse Source
This commit is contained in:
Gennaro Prota
2025-09-15 16:28:19 +02:00
parent ac6b01140d
commit 51db99cf32
1 changed files with 14 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
include/boost/dynamic_bitset/dynamic_bitset.hpp
View File

@@ -350,23 +350,23 @@ public:
// -----------------------------------------------------------------------
explicit dynamic_bitset( size_type num_bits, unsigned long value = 0, const allocator_type & alloc = allocator_type() );
//! Constructs a bitset from a string of 0's and 1's. The size
//! of the bitset is `num_bits` if `num_bits != npos`, otherwise
//! `rlen = min( n, s.size() - pos )`. The first `M = min(
//! num_bits, rlen )` bits are initialized to the corresponding
//! characters in `s`. Note that the highest character position
//! in `s`, not the lowest, corresponds to the least significant
//! bit. So, for example, `dynamic_bitset( std::string( "1101" )
//! )` is the same as `dynamic_bitset( 13ul )`.
//! Constructs a bitset from a string of 0's and 1's.
//!
//! The size of the bitset is `num_bits` if `num_bits != npos`,
//! otherwise `rlen = min( n, s.size() - pos )`. The first `M =
//! min( num_bits, rlen )` bits are initialized to the
//! corresponding characters in `s`. Note that the highest
//! character position in `s`, not the lowest, corresponds to
//! the least significant bit. So, for example, `dynamic_bitset(
//! std::string( "1101" ))` is the same as `dynamic_bitset(
//! 13ul)`.
//!
//! \pre
//! `pos <= s.size()` and the characters used to initialize the
//! bits compare equal to either `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '0' )`
//! or `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '1' )`. E.g.:
//!
//! \code
//! dynamic_bitset<> b( std::string( "10xyz" ), 0, 2 ); // OK
//! \endcode
//! `dynamic_bitset<> b( std::string( "10xyz" ), 0, 2 ); // OK`.
//!
//! \param s The string to construct from.
//! \param pos The start position in the string.
@@ -391,10 +391,7 @@ public:
//! The characters in `s` that are used to initialize the bits
//! compare equal to either `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '0' )`
//! or `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '1' )`. E.g.:
//!
//! \code
//! dynamic_bitset<> b( "10xyz", 2 ); // OK
//! \endcode
//! `dynamic_bitset<> b( "10xyz", 2 ); // OK`.
//!
//! \param s The string to construct from.
//! \param n The maximum number of characters in the string to
@@ -417,10 +414,7 @@ public:
//! The characters in `sv` that are use to initialize the bits
//! compare equal to either `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '0' )`
//! or `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '1' )`. E.g.:
//!
//! \code
//! dynamic_bitset<> b( std::string_view( "10xyz", 2 ) ); // OK
//! \endcode
//! `dynamic_bitset<> b( std::string_view( "10xyz", 2 ) ); // OK`.
//!
//! \param sv The basic_string_view to construct from.
//! \param num_bits The size of the bitset to construct, if