Skip to content
Snippets Groups Projects
Commit 594cbe4e authored by tho's avatar tho
Browse files

some small documentation fixes

parent 13b762bd
No related branches found
No related tags found
No related merge requests found
...@@ -147,7 +147,7 @@ namespace connector { ...@@ -147,7 +147,7 @@ namespace connector {
notifications. */ notifications. */
template <class Handler> template <class Handler>
void onUnthrottle(Handler handler); ///< Register unthrottle notification handler void onUnthrottle(Handler handle); ///< Register unthrottle notification handler
/**< The handler register here will be called, whenever an /**< The handler register here will be called, whenever an
unthrottle notification comes in. The \a handler unthrottle notification comes in. The \a handler
argument is either an arbitrary callable object or it argument is either an arbitrary callable object or it
......
...@@ -178,7 +178,7 @@ namespace senf { ...@@ -178,7 +178,7 @@ namespace senf {
range. read returns a past-the-end iterator after the range. read returns a past-the-end iterator after the
last character read. This iterator will point to last character read. This iterator will point to
somewhere within the input range. somewhere within the input range.
\param[in/out] range Range to store data in \param[in,out] range Range to store data in
\returns past-the-end iterator pointer to after the \returns past-the-end iterator pointer to after the
last read character last read character
\see \ref read() \n \see \ref read() \n
...@@ -239,7 +239,7 @@ namespace senf { ...@@ -239,7 +239,7 @@ namespace senf {
range. read returns a past-the-end iterator after the range. read returns a past-the-end iterator after the
last character read. This iterator will point to last character read. This iterator will point to
somewhere within the input range. somewhere within the input range.
\param[in/out] range Range to store data in \param[in,out] range Range to store data in
\param[out] from peers address from which the data was \param[out] from peers address from which the data was
received received
\returns past-the-end iterator pointer to after the \returns past-the-end iterator pointer to after the
......
...@@ -120,7 +120,7 @@ namespace senf { ...@@ -120,7 +120,7 @@ namespace senf {
\param[in] handle socket handle to write data to \param[in] handle socket handle to write data to
\param[in] buffer address of buffer to send \param[in] buffer address of buffer to send
\param[in] size number of bytes to write \param[in] size number of bytes to write
\param[in] address peer to send data to \param[in] addr peer to send data to
\returns number of bytes written \returns number of bytes written
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment