diff --git a/Socket/ClientSocketHandle.hh b/Socket/ClientSocketHandle.hh index f4e1c32b6d3ceeae7c551468b9927a285f12d8bf..fbecf6dce463780258049e3518c8a48566b52205 100644 --- a/Socket/ClientSocketHandle.hh +++ b/Socket/ClientSocketHandle.hh @@ -267,14 +267,15 @@ namespace senf { \see \ref readfrom() */ char * readfrom (char * start, char * end, Address & from); ///< Read data into memory buffer - /**< This variant will read data into the memory area at \c - buffer of size \c size. This is the most performant - version of readfrom(). - \param[in] buffer address of buffer to store data at - \param[in] size size of buffer - \param[out] from peer address - \returns Number of bytes read - \see \ref readfrom() */ + /**< This variant will read data into the memory area from + \a start to before \a end. This is guaranteed to be the + most efficient version of readfrom(). + \param[in] start address of buffer to store data at + \param[in] end address one past the end of the buffer + \param[out] from peers address from which the data was + received + \returns pointer past the end of the data read + \see \ref read() */ /** \brief Write data to socket