stream_srv: Improve API documentation

Change-Id: Ib41eeef3a21ec55a175b6bbb818d05c091b46df5
---
M src/stream_srv.c
1 file changed, 9 insertions(+), 3 deletions(-)


git pull ssh://gerrit.osmocom.org:29418/libosmo-netif refs/changes/85/40485/1

diff --git a/src/stream_srv.c b/src/stream_srv.c
index be950ce..5ffb28b 100644
--- a/src/stream_srv.c
+++ b/src/stream_srv.c
@@ -628,7 +628,7 @@
 }
 
 /*! Set given parameter of stream_srv_link to given value.
- *  \param[in] cli stream client on which to set parameter.
+ *  \param[in] link stream server link on which to set parameter.
  *  \param[in] par identifier of the parameter to be set.
  *  \param[in] val value of the parameter to be set.
  *  \param[in] val_len length of the parameter value.
@@ -916,7 +916,10 @@
  *  \param[in] read_cb Call-back to call when the socket is readable
  *  \param[in] closed_cb Call-back to call when the connection is closed
  *  \param[in] data User data to save in the new Stream Server struct
- *  \returns Stream Server in case of success; NULL on error */
+ *  \returns Stream Server in case of success; NULL on error
+ *
+ *  Note: In case of error, the caller is responsible for closing the fd.
+ */
 struct osmo_stream_srv *
 osmo_stream_srv_create(void *ctx, struct osmo_stream_srv_link *link, int fd,
 		       osmo_stream_srv_read_cb_t read_cb,
@@ -959,7 +962,10 @@
  *  \param[in] link Stream Server Link to which we belong
  *  \param[in] fd system file descriptor of the new connection
  *  \param[in] data User data to save in the new Stream Server struct
- *  \returns Stream Server in case of success; NULL on error */
+ *  \returns Stream Server in case of success; NULL on error
+ *
+ *  Note: In case of error, the caller is responsible for closing the fd.
+ */
 struct osmo_stream_srv *
 osmo_stream_srv_create2(void *ctx, struct osmo_stream_srv_link *link, int fd, void *data)
 {

