doc style fix

Signed-off-by: Mattias Andrée <maandree@operamail.com>

22 files changed, 35 insertions, 35 deletions

diff --git a/src/libmdsserver/client-list.c b/src/libmdsserver/client-list.c
index d7d7c9c..66fc2ae 100644
--- a/src/libmdsserver/client-list.c
+++ b/src/libmdsserver/client-list.c
@@ -127,7 +127,7 @@ int client_list_clone(const client_list_t* restrict this, client_list_t* restric
  * 
  * @param   this    The list
  * @param   client  The client to add
- * @return          Non-zero on error, errno will be set accordingly
+ * @return          Non-zero on error, `errno` will be set accordingly
  */
 int client_list_add(client_list_t* restrict this, uint64_t client)
 {
@@ -212,7 +212,7 @@ void client_list_marshal(const client_list_t* restrict this, char* restrict data
  * 
  * @param   this  Memory slot in which to store the new client list
  * @param   data  In buffer with the marshalled data
- * @return        Non-zero on error, errno will be set accordingly.
+ * @return        Non-zero on error, `errno` will be set accordingly.
  *                Destroy the list on error.
  */
 int client_list_unmarshal(client_list_t* restrict this, char* restrict data)
diff --git a/src/libmdsserver/client-list.h b/src/libmdsserver/client-list.h
index 1894b63..bfb184f 100644
--- a/src/libmdsserver/client-list.h
+++ b/src/libmdsserver/client-list.h
@@ -82,7 +82,7 @@ int client_list_clone(const client_list_t* restrict this, client_list_t* restric
  * 
  * @param   this    The list
  * @param   client  The client to add
- * @return          Non-zero on error, errno will be set accordingly
+ * @return          Non-zero on error, `errno` will be set accordingly
  */
 int client_list_add(client_list_t* restrict this, uint64_t client);
 
@@ -115,7 +115,7 @@ void client_list_marshal(const client_list_t* restrict this, char* restrict data
  * 
  * @param   this  Memory slot in which to store the new client list
  * @param   data  In buffer with the marshalled data
- * @return        Non-zero on error, errno will be set accordingly.
+ * @return        Non-zero on error, `errno` will be set accordingly.
  *                Destroy the list on error.
  */
 int client_list_unmarshal(client_list_t* restrict this, char* restrict data);
diff --git a/src/libmdsserver/fd-table.c b/src/libmdsserver/fd-table.c
index 0852eb6..960b3e4 100644
--- a/src/libmdsserver/fd-table.c
+++ b/src/libmdsserver/fd-table.c
@@ -268,7 +268,7 @@ void fd_table_marshal(const fd_table_t* restrict this, char* restrict data)
  * @param   this      Memory slot in which to store the new fd table
  * @param   data      In buffer with the marshalled data
  * @param   remapper  Function that translates values, `NULL` if not translation takes place
- * @return            Non-zero on error, errno will be set accordingly.
+ * @return            Non-zero on error, `errno` will be set accordingly.
  *                    Destroy the table on error.
  */
 int fd_table_unmarshal(fd_table_t* restrict this, char* restrict data, remap_func* remapper)
diff --git a/src/libmdsserver/fd-table.h b/src/libmdsserver/fd-table.h
index 289a401..bd5a2f7 100644
--- a/src/libmdsserver/fd-table.h
+++ b/src/libmdsserver/fd-table.h
@@ -170,7 +170,7 @@ void fd_table_marshal(const fd_table_t* restrict this, char* restrict data);
  * @param   this      Memory slot in which to store the new fd table
  * @param   data      In buffer with the marshalled data
  * @param   remapper  Function that translates values, `NULL` if not translation takes place
- * @return            Non-zero on error, errno will be set accordingly.
+ * @return            Non-zero on error, `errno` will be set accordingly.
  *                    Destroy the table on error.
  */
 int fd_table_unmarshal(fd_table_t* restrict this, char* restrict data, remap_func* remapper);
diff --git a/src/libmdsserver/hash-table.c b/src/libmdsserver/hash-table.c
index dac9303..c0de355 100644
--- a/src/libmdsserver/hash-table.c
+++ b/src/libmdsserver/hash-table.c
@@ -65,7 +65,7 @@ static inline size_t __attribute__((pure)) truncate_hash(const hash_table_t* res
  * Grow the table
  * 
  * @param   this  The hash table
- * @return        Non zero on error, errno will be set accordingly
+ * @return        Non zero on error, `errno` will be set accordingly
  */
 static int rehash(hash_table_t* restrict this)
 {
@@ -453,7 +453,7 @@ void hash_table_marshal(const hash_table_t* restrict this, char* restrict data)
  * @param   this      Memory slot in which to store the new hash table
  * @param   data      In buffer with the marshalled data
  * @param   remapper  Function that translates values, `NULL` if not translation takes place
- * @return            Non-zero on error, errno will be set accordingly.
+ * @return            Non-zero on error, `errno` will be set accordingly.
  *                    Destroy the table on error.
  */
 int hash_table_unmarshal(hash_table_t* restrict this, char* restrict data, remap_func* remapper)
diff --git a/src/libmdsserver/hash-table.h b/src/libmdsserver/hash-table.h
index 789af20..21a6b2f 100644
--- a/src/libmdsserver/hash-table.h
+++ b/src/libmdsserver/hash-table.h
@@ -252,7 +252,7 @@ void hash_table_marshal(const hash_table_t* restrict this, char* restrict data);
  * @param   this      Memory slot in which to store the new hash table
  * @param   data      In buffer with the marshalled data
  * @param   remapper  Function that translates values, `NULL` if not translation takes place
- * @return            Non-zero on error, errno will be set accordingly.
+ * @return            Non-zero on error, `errno` will be set accordingly.
  *                    Destroy the table on error.
  */
 int hash_table_unmarshal(hash_table_t* restrict this, char* restrict data, remap_func* remapper);
diff --git a/src/libmdsserver/linked-list.c b/src/libmdsserver/linked-list.c
index 292c610..6c8e185 100644
--- a/src/libmdsserver/linked-list.c
+++ b/src/libmdsserver/linked-list.c
@@ -427,7 +427,7 @@ void linked_list_marshal(const linked_list_t* restrict this, char* restrict data
  * 
  * @param   this  Memory slot in which to store the new linked list
  * @param   data  In buffer with the marshalled data
- * @return        Non-zero on error, errno will be set accordingly.
+ * @return        Non-zero on error, `errno` will be set accordingly.
  *                Destroy the list on error.
  */
 int linked_list_unmarshal(linked_list_t* restrict this, char* restrict data)
diff --git a/src/libmdsserver/linked-list.h b/src/libmdsserver/linked-list.h
index d6f56c5..3a512aa 100644
--- a/src/libmdsserver/linked-list.h
+++ b/src/libmdsserver/linked-list.h
@@ -262,7 +262,7 @@ void linked_list_marshal(const linked_list_t* restrict this, char* restrict data
  * 
  * @param   this  Memory slot in which to store the new linked list
  * @param   data  In buffer with the marshalled data
- * @return        Non-zero on error, errno will be set accordingly.
+ * @return        Non-zero on error, `errno` will be set accordingly.
  *                Destroy the list on error.
  */
 int linked_list_unmarshal(linked_list_t* restrict this, char* restrict data);
diff --git a/src/mds-base.c b/src/mds-base.c
index 8d3eb79..6aebb62 100644
--- a/src/mds-base.c
+++ b/src/mds-base.c
@@ -306,8 +306,8 @@ void __attribute__((weak)) signal_all(int signo)
 static void __attribute__((const)) received_noop(int signo)
 {
   (void) signo;
-  /* This function is used rather than SIG_IGN because we
-   * want blocking functions to return with errno set to
+  /* This function is used rather than `SIG_IGN` because we
+   * want blocking functions to return with `errno` set to
    * `EINTR` rather than continue blocking. */
 }
 
diff --git a/src/mds-echo.h b/src/mds-echo.h
index 34a12e9..2bf9fd2 100644
--- a/src/mds-echo.h
+++ b/src/mds-echo.h
@@ -26,7 +26,7 @@
  * Echo the received message payload
  * 
  * @return  Zero on success -1 on error or interruption,
- *          errno will be set accordingly
+ *          `errno` will be set accordingly
  */
 int echo_message(void);
 
diff --git a/src/mds-registry/registry.c b/src/mds-registry/registry.c
index 726d361..23eeafe 100644
--- a/src/mds-registry/registry.c
+++ b/src/mds-registry/registry.c
@@ -41,7 +41,7 @@
  * Handle the received message containing a ‘Client closed’-header
  * 
  * @return  Zero on success -1 on error or interruption,
- *          errno will be set accordingly
+ *          `errno` will be set accordingly
  */
 static int handle_close_message(void)
 {
@@ -256,7 +256,7 @@ static int registry_action_act(char* command, int action, uint64_t client, hash_
  * @param   recv_client_id   The ID of the client
  * @param   recv_message_id  The ID of the received message
  * @return                   Zero on success -1 on error or interruption,
- *                           errno will be set accordingly
+ *                           `errno` will be set accordingly
  */
 static int registry_action(size_t length, int action, const char* recv_client_id, const char* recv_message_id)
 {
@@ -337,7 +337,7 @@ static int registry_action(size_t length, int action, const char* recv_client_id
  * @param   recv_client_id   The ID of the client
  * @param   recv_message_id  The ID of the received message
  * @return                   Zero on success -1 on error or interruption,
- *                           errno will be set accordingly
+ *                           `errno` will be set accordingly
  */
 static int list_registry(const char* recv_client_id, const char* recv_message_id)
 {
@@ -489,7 +489,7 @@ static int handle_register_message(void)
  * Handle the received message
  * 
  * @return  Zero on success -1 on error or interruption,
- *          errno will be set accordingly
+ *          `errno` will be set accordingly
  */
 int handle_message(void)
 {
diff --git a/src/mds-registry/registry.h b/src/mds-registry/registry.h
index 8d2a276..0de4d6f 100644
--- a/src/mds-registry/registry.h
+++ b/src/mds-registry/registry.h
@@ -23,7 +23,7 @@
  * Handle the received message
  * 
  * @return  Zero on success -1 on error or interruption,
- *          errno will be set accordingly
+ *          `errno` will be set accordingly
  */
 int handle_message(void);
 
diff --git a/src/mds-registry/slave.c b/src/mds-registry/slave.c
index bda6ca6..3825472 100644
--- a/src/mds-registry/slave.c
+++ b/src/mds-registry/slave.c
@@ -408,8 +408,8 @@ size_t slave_marshal(const slave_t* restrict this, char* restrict data)
  * 
  * @param   this  Memory slot in which to store the new slave information
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes.
- *                Destroy the slave information on error.
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the
+ *                number of read bytes. Destroy the slave information on error.
  */
 size_t slave_unmarshal(slave_t* restrict this, char* restrict data)
 {
diff --git a/src/mds-registry/slave.h b/src/mds-registry/slave.h
index cb30b94..7e9142d 100644
--- a/src/mds-registry/slave.h
+++ b/src/mds-registry/slave.h
@@ -163,8 +163,8 @@ size_t slave_marshal(const slave_t* restrict this, char* restrict data);
  * 
  * @param   this  Memory slot in which to store the new slave information
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes.
- *                Destroy the slave information on error.
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the
+ *                number of read bytes. Destroy the slave information on error.
  */
 size_t slave_unmarshal(slave_t* restrict this, char* restrict data);
 
diff --git a/src/mds-server/client.c b/src/mds-server/client.c
index f9244ef..99d561e 100644
--- a/src/mds-server/client.c
+++ b/src/mds-server/client.c
@@ -198,7 +198,7 @@ size_t client_marshal(const client_t* restrict this, char* restrict data)
  * 
  * @param   this  Memory slot in which to store the new client information
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the number of read bytes
  */
 size_t client_unmarshal(client_t* restrict this, char* restrict data)
 {
diff --git a/src/mds-server/client.h b/src/mds-server/client.h
index cd838a0..9ea007f 100644
--- a/src/mds-server/client.h
+++ b/src/mds-server/client.h
@@ -199,8 +199,8 @@ size_t client_marshal(const client_t* restrict this, char* restrict data);
  * 
  * @param   this  Memory slot in which to store the new client information
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes.
- *                Destroy the client information on error.
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the
+ *                number of read bytes. Destroy the client information on error.
  */
 size_t client_unmarshal(client_t* restrict this, char* restrict data);
 
diff --git a/src/mds-server/interception-condition.c b/src/mds-server/interception-condition.c
index 091a6e5..31905c9 100644
--- a/src/mds-server/interception-condition.c
+++ b/src/mds-server/interception-condition.c
@@ -59,7 +59,7 @@ size_t interception_condition_marshal(const interception_condition_t* restrict t
  * 
  * @param   this  Memory slot in which to store the new interception condition
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the number of read bytes
  */
 size_t interception_condition_unmarshal(interception_condition_t* restrict this, char* restrict data)
 {
diff --git a/src/mds-server/interception-condition.h b/src/mds-server/interception-condition.h
index 19f2c68..65b7ebc 100644
--- a/src/mds-server/interception-condition.h
+++ b/src/mds-server/interception-condition.h
@@ -78,8 +78,8 @@ size_t interception_condition_marshal(const interception_condition_t* restrict t
  * 
  * @param   this  Memory slot in which to store the new interception condition
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes.
- *                Destroy the interception condition on error.
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the
+ *                number of read bytes. Destroy the interception condition on error.
  */
 size_t interception_condition_unmarshal(interception_condition_t* restrict this, char* restrict data);
 
diff --git a/src/mds-server/multicast.c b/src/mds-server/multicast.c
index 7d92eba..7a0b309 100644
--- a/src/mds-server/multicast.c
+++ b/src/mds-server/multicast.c
@@ -107,8 +107,8 @@ size_t multicast_marshal(const multicast_t* restrict this, char* restrict data)
  * 
  * @param   this  Memory slot in which to store the new message multicast state
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes.
- *                Destroy the client information on error.
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the
+ *                number of read bytes. Destroy the client information on error.
  */
 size_t multicast_unmarshal(multicast_t* restrict this, char* restrict data)
 {
diff --git a/src/mds-server/multicast.h b/src/mds-server/multicast.h
index 4747a20..020c9b9 100644
--- a/src/mds-server/multicast.h
+++ b/src/mds-server/multicast.h
@@ -103,8 +103,8 @@ size_t multicast_marshal(const multicast_t* restrict this, char* restrict data);
  * 
  * @param   this  Memory slot in which to store the new message multicast state
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes.
- *                Destroy the message multicast state on error.
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the
+ *                number of read bytes. Destroy the message multicast state on error.
  */
 size_t multicast_unmarshal(multicast_t* restrict this, char* restrict data);
 
diff --git a/src/mds-server/queued-interception.c b/src/mds-server/queued-interception.c
index 22e01b7..aa646f1 100644
--- a/src/mds-server/queued-interception.c
+++ b/src/mds-server/queued-interception.c
@@ -54,7 +54,7 @@ size_t queued_interception_marshal(const queued_interception_t* restrict this, c
  * 
  * @param   this  Memory slot in which to store the new queued interception
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes.
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the number of read bytes.
  */
 size_t queued_interception_unmarshal(queued_interception_t* restrict this, char* restrict data)
 {
diff --git a/src/mds-server/queued-interception.h b/src/mds-server/queued-interception.h
index 3c7fe51..54413a3 100644
--- a/src/mds-server/queued-interception.h
+++ b/src/mds-server/queued-interception.h
@@ -76,7 +76,7 @@ size_t queued_interception_marshal(const queued_interception_t* restrict this, c
  * 
  * @param   this  Memory slot in which to store the new queued interception
  * @param   data  In buffer with the marshalled data
- * @return        Zero on error, errno will be set accordingly, otherwise the number of read bytes.
+ * @return        Zero on error, `errno` will be set accordingly, otherwise the number of read bytes.
  */
 size_t queued_interception_unmarshal(queued_interception_t* restrict this, char* restrict data);