[Boost-bugs] [Boost C++ Libraries] #1591: Documentation Corrections - Non-Member Functions

Subject: [Boost-bugs] [Boost C++ Libraries] #1591: Documentation Corrections - Non-Member Functions
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2008-01-22 17:35:21

#1591: Documentation Corrections - Non-Member Functions
-------------------------------------------------------+--------------------
 Reporter:  Charles Brockman <cmbrockman_at_[hidden]>  |       Owner:  jsiek         
     Type:  Patches                                    |      Status:  new           
Milestone:  Boost 1.36.0                               |   Component:  dynamic_bitset
  Version:  Boost 1.34.1                               |    Severity:  Problem       
 Keywords:                                             |  
-------------------------------------------------------+--------------------
 In the documentation at ''/libs/dynamic_bitset/dynamic_bitset.html'', I
 think there are errors in two sentences.

 In the Non-Member Functions section, see operator& and the two following
 functions, operator| and operator!^. The second sentence of each Returns
 paragraph is identical among the three descriptions:

 ''Note that the expression b1 & b2 is equivalent to creating a temporary
 copy
 of b1, using operator&=, and returning the temporary copy.''

 I think the operator| part should read:
 ''Note that the expression b1 | b2 is equivalent to creating a temporary
 copy
 of b1, using operator|=, and returning the temporary copy.''

 and the operator!^ part should read:
 ''Note that the expression b1 !^ b2 is equivalent to creating a temporary
 copy
 of b1, using operator!^=, and returning the temporary copy.''

 The similar Returns paragraph at operator- appears to be correct.

-- 
Ticket URL: <http://svn.boost.org/trac/boost/ticket/1591>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.