[Boost-bugs] [Boost C++ Libraries] #3284: Incorrect documentation for interprocess::shared_memory_mapping::get_size

Subject: [Boost-bugs] [Boost C++ Libraries] #3284: Incorrect documentation for interprocess::shared_memory_mapping::get_size
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2009-07-23 16:14:23

#3284: Incorrect documentation for interprocess::shared_memory_mapping::get_size
----------------------------------------------+-----------------------------
 Reporter:  Bryan Donlan <bdonlan@…>          |       Owner:  igaztanaga  
     Type:  Patches                           |      Status:  new         
Milestone:  Boost 1.40.0                      |   Component:  interprocess
  Version:  Boost Development Trunk           |    Severity:  Cosmetic    
 Keywords:  documentation                     |  
----------------------------------------------+-----------------------------
 In 1.39.0 and SVN trunk,
 boost::interprocess::shared_memory_mapping::get_size is documented as:

    //!Returns the name of the file
    //!used in the constructor
    bool get_size(offset_t &size) const;

 This is obviously incorrect. I've attached a proposed documentation patch
 to correct this.

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