[Boost-bugs] [Boost C++ Libraries] #13543: documentation for allocation_command shows the wrong return type

Subject: [Boost-bugs] [Boost C++ Libraries] #13543: documentation for allocation_command shows the wrong return type
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2018-04-26 17:06:47

#13543: documentation for allocation_command shows the wrong return type
------------------------------+---------------------------
 Reporter:  matt.liberty@…    |      Owner:  Ion Gaztañaga
     Type:  Bugs              |     Status:  new
Milestone:  To Be Determined  |  Component:  interprocess
  Version:  Boost 1.59.0      |   Severity:  Problem
 Keywords:                    |
------------------------------+---------------------------
 The documentation at

 https://www.boost.org/doc/libs/1_59_0/doc/html/interprocess/managed_memory_segments.html#interprocess.managed_memory_segments.managed_memory_segment_advanced_features.managed_memory_segment_expand_in_place

 shows the return type for allocation_command is "std::pair<T *, bool>".
 The code doesn't match and just returns a "T *".  The example also
 disagrees and shows:

 std::size_t * ret = managed_shm.allocation_command

 The pair would actually be nicer but either the code or the docs need
 updating.  The same problem appears in later versions.

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