Skip to content

Commit 8b729ca

Browse files
committed
Fix a few documentation glitches
1 parent a6a7ffa commit 8b729ca

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

include/boost/dynamic_bitset/dynamic_bitset.hpp

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -350,23 +350,23 @@ class dynamic_bitset
350350
// -----------------------------------------------------------------------
351351
explicit dynamic_bitset( size_type num_bits, unsigned long value = 0, const allocator_type & alloc = allocator_type() );
352352

353-
//! Constructs a bitset from a string of 0's and 1's. The size
354-
//! of the bitset is `num_bits` if `num_bits != npos`, otherwise
355-
//! `rlen = min( n, s.size() - pos )`. The first `M = min(
356-
//! num_bits, rlen )` bits are initialized to the corresponding
357-
//! characters in `s`. Note that the highest character position
358-
//! in `s`, not the lowest, corresponds to the least significant
359-
//! bit. So, for example, `dynamic_bitset( std::string( "1101" )
360-
//! )` is the same as `dynamic_bitset( 13ul )`.
353+
//! Constructs a bitset from a string of 0's and 1's.
354+
//!
355+
//! The size of the bitset is `num_bits` if `num_bits != npos`,
356+
//! otherwise `rlen = min( n, s.size() - pos )`. The first `M =
357+
//! min( num_bits, rlen )` bits are initialized to the
358+
//! corresponding characters in `s`. Note that the highest
359+
//! character position in `s`, not the lowest, corresponds to
360+
//! the least significant bit. So, for example, `dynamic_bitset(
361+
//! std::string( "1101" ))` is the same as `dynamic_bitset(
362+
//! 13ul)`.
361363
//!
362364
//! \pre
363365
//! `pos <= s.size()` and the characters used to initialize the
364366
//! bits compare equal to either `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '0' )`
365367
//! or `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '1' )`. E.g.:
366-
//!
367-
//! \code
368-
//! dynamic_bitset<> b( std::string( "10xyz" ), 0, 2 ); // OK
369-
//! \endcode
368+
//! `dynamic_bitset<> b( std::string( "10xyz" ), 0, 2 ); // OK`.
369+
370370
//!
371371
//! \param s The string to construct from.
372372
//! \param pos The start position in the string.
@@ -391,10 +391,7 @@ class dynamic_bitset
391391
//! The characters in `s` that are used to initialize the bits
392392
//! compare equal to either `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '0' )`
393393
//! or `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '1' )`. E.g.:
394-
//!
395-
//! \code
396-
//! dynamic_bitset<> b( "10xyz", 2 ); // OK
397-
//! \endcode
394+
//! `dynamic_bitset<> b( "10xyz", 2 ); // OK`.
398395
//!
399396
//! \param s The string to construct from.
400397
//! \param n The maximum number of characters in the string to
@@ -417,10 +414,7 @@ class dynamic_bitset
417414
//! The characters in `sv` that are use to initialize the bits
418415
//! compare equal to either `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '0' )`
419416
//! or `std::use_facet< std::ctype< CharT > >( std::locale() ).widen( '1' )`. E.g.:
420-
//!
421-
//! \code
422-
//! dynamic_bitset<> b( std::string_view( "10xyz", 2 ) ); // OK
423-
//! \endcode
417+
//! `dynamic_bitset<> b( std::string_view( "10xyz", 2 ) ); // OK`.
424418
//!
425419
//! \param sv The basic_string_view to construct from.
426420
//! \param num_bits The size of the bitset to construct, if

0 commit comments

Comments
 (0)