forb: Update forb_server_id_to_string() documentation

[frescor/forb.git] / src / server_id.h

diff --git a/src/server_id.h b/src/server_id.h
index 17effdc38a6f0925f29fdba49b200eb17b178660..68d3568f20cea8da2fc15cbfbbe729a5ae5211ce 100644 (file)
--- a/src/server_id.h
+++ b/src/server_id.h
@@ -41,7 +41,7 @@ forb_server_id_to_string(char *dest, const forb_server_id *server_id, size_t n)
  * @param server_id Initialized server ID.
  * @param string String form of server ID.
  * 
- * @return Same value as @a server_id.
+ * @return Same value as @a server_id, NULL in the case of error.
  */
 static inline forb_server_id * 
 forb_server_id_from_string(forb_server_id *server_id, const char *string)