Mercurial > code

changeset 566:72390061044d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Net: improve documentation a bit
author David Demelier <markand@malikania.fr>
date Fri, 24 Jun 2016 13:00:35 +0200
parents a1841ba6eb61
children 4828eca0f78d
files modules/net/net.hpp
diffstat 1 files changed, 24 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/modules/net/net.hpp	Thu Jun 23 13:50:27 2016 +0200
+++ b/modules/net/net.hpp	Fri Jun 24 13:00:35 2016 +0200
@@ -371,8 +371,8 @@
  *
  * ## Throws
  *
- *   - **WouldBlockError**: if the operation would block,
- *   - **Error**: on other error.
+ *   - \a net::WouldBlockError: if the operation would block,
+ *   - \a net::Error: on other error.
  *
  * # accept
  *
@@ -393,8 +393,8 @@
  *
  * ## Throws
  *
- *   - **WouldBlockError**: if the operation would block,
- *   - **Error**: on other error.
+ *   - net::WouldBlockError: if the operation would block,
+ *   - net::Error: on other error.
  *
  * # recv
  *
@@ -415,6 +415,11 @@
  *
  * The number of bytes sent.
  *
+ * ## Throws
+ *
+ *   - net::WouldBlockError: if the operation would block,
+ *   - net::Error: on other error.
+ *
  * # send
  *
  * Send data.
@@ -433,6 +438,11 @@
  * ## Returns
  *
  * The number of bytes sent.
+ *
+ * ## Throws
+ *
+ *   - net::WouldBlockError: if the operation would block,
+ *   - net::Error: on other error.
  */
 
 /**
@@ -476,6 +486,11 @@
  *
  * The number of bytes received.
  *
+ * ## Throws
+ *
+ *   - net::WouldBlockError: if the operation would block,
+ *   - net::Error: on other error.
+ *
  * # sendto
  *
  * ````
@@ -493,6 +508,11 @@
  * ## Returns
  *
  * The number of bytes sent.
+ *
+ * ## Throws
+ *
+ *   - net::WouldBlockError: if the operation would block,
+ *   - net::Error: on other error.
  */
 
 /*