Documentation fixes.

This commit is contained in:
Christopher Kohlhoff 2015-02-15 18:03:22 +11:00
parent cd6ddda029
commit 6f13c5bd15
3 changed files with 16 additions and 6 deletions

View File

@ -1360,6 +1360,8 @@ public:
* sequence. The object stores a reference to the string and the user is
* responsible for ensuring that the string object remains valid until the
* dynamic_string_buffer object is destroyed.
*
* @param maximum_size Specifies a maximum size for the buffer, in bytes.
*/
explicit dynamic_string_buffer(std::basic_string<Elem, Traits, Allocator>& s,
std::size_t maximum_size = (std::numeric_limits<std::size_t>::max)())
@ -1503,11 +1505,13 @@ public:
/// Construct a dynamic buffer from a string.
/**
* @param s The string to be used as backing storage for the dynamic buffer.
* Any existing data in the string is treated as the dynamic buffer's input
* sequence. The object stores a reference to the string and the user is
* responsible for ensuring that the string object remains valid until the
* @param v The vector to be used as backing storage for the dynamic buffer.
* Any existing data in the vector is treated as the dynamic buffer's input
* sequence. The object stores a reference to the vector and the user is
* responsible for ensuring that the vector object remains valid until the
* dynamic_vector_buffer object is destroyed.
*
* @param maximum_size Specifies a maximum size for the buffer, in bytes.
*/
explicit dynamic_vector_buffer(std::vector<Elem, Allocator>& v,
std::size_t maximum_size = (std::numeric_limits<std::size_t>::max)())

View File

@ -212,7 +212,7 @@ public:
* given service type. If there is no existing implementation of the service,
* then the io_service will create a new instance of the service.
*
* @param i The io_service object that owns the service.
* @param ios The io_service object that owns the service.
*
* @return The service interface implementing the specified service type.
* Ownership of the service interface is not transferred to the caller.
@ -221,7 +221,7 @@ public:
* that inherit from io_service::service.
*/
template <typename Service>
friend Service& use_service(io_service& i);
friend Service& use_service(io_service& ios);
#if defined(GENERATING_DOCUMENTATION)

View File

@ -268,10 +268,16 @@ ASIO_DECL address_v6 make_address_v6(
enum v4_mapped_t { v4_mapped };
/// Create an IPv4 address from a IPv4-mapped IPv6 address.
/**
* @relates address_v4
*/
ASIO_DECL address_v4 make_address_v4(
v4_mapped_t, const address_v6& v6_addr);
/// Create an IPv4-mapped IPv6 address from an IPv4 address.
/**
* @relates address_v6
*/
ASIO_DECL address_v6 make_address_v6(
v4_mapped_t, const address_v4& v4_addr);