From: g0dil Date: Mon, 9 Jul 2007 13:53:22 +0000 (+0000) Subject: Close bugs: #11525 X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=52a1b4f399650138cdd7f5e111200ac5f6702be3;p=senf.git Close bugs: #11525 git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@291 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Socket/ClientSocketHandle.hh b/Socket/ClientSocketHandle.hh index f4e1c32..fbecf6d 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