[Boost-bugs] [Boost C++ Libraries] #8358: queue::push inchorent documentation

Subject: [Boost-bugs] [Boost C++ Libraries] #8358: queue::push inchorent documentation
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2013-03-31 10:14:27

#8358: queue::push inchorent documentation
------------------------------+---------------------------------------------
 Reporter:  viboes            |       Owner:  timblechmann
     Type:  Bugs              |      Status:  new         
Milestone:  To Be Determined  |   Component:  lockfree    
  Version:  Boost 1.53.0      |    Severity:  Problem     
 Keywords:                    |  
------------------------------+---------------------------------------------
 The documentation of queue::push states in the postcondition that the
 object is pushed if the queue if internal node can be allocated, but this
 in contradiction with Note that states that a new node could be allocated
 from the OS.

 I suggest to add a Effects clause to all the documentation to states
 clearly the effects of each function, as it done for the C++ standard and
 a lot of Boost libraries.

 {{{
 bool push(T const & t);

 Pushes object t to the queue.

 Note

 Thread-safe. If internal memory pool is exhausted and the memory pool is
 not fixed-sized, a new node will be allocated from the OS. This may not be
 lock-free.

 Postconditions:

 object will be pushed to the queue, if internal node can be allocated

 Returns:

 true, if the push operation is successful.
 }}}

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