[Boost-bugs] [Boost C++ Libraries] #9771: Incorrect documentation for basic_datagram_socket::async_send()

Subject: [Boost-bugs] [Boost C++ Libraries] #9771: Incorrect documentation for basic_datagram_socket::async_send()
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2014-03-12 15:40:02

#9771: Incorrect documentation for basic_datagram_socket::async_send()
------------------------------+----------------------------
 Reporter:  mike.catanzaro@…  |      Owner:  chris_kohlhoff
     Type:  Bugs              |     Status:  new
Milestone:  To Be Determined  |  Component:  asio
  Version:  Boost 1.55.0      |   Severity:  Problem
 Keywords:                    |
------------------------------+----------------------------
 The documentation for the first overload (without the
 socket_base::message_flags parameter) of
 basic_datagram_socket::async_send() appears to be incorrect. The
 documentation says:

 "This function is used to send data on the datagram socket. The function
 call will block until the data has been sent successfully or an error
 occurs."

 It should probably match the second overload, which appears to be correct:

 "This function is used to asynchronously send data on the datagram socket.
 The function call always returns immediately."

 First (incorrect) overload:
 http://www.boost.org/doc/libs/1_55_0/doc/html/boost_asio/reference/basic_datagram_socket/async_send/overload1.html


 Second (correct) overload:
 http://www.boost.org/doc/libs/1_55_0/doc/html/boost_asio/reference/basic_datagram_socket/async_send/overload2.html

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