This is merely a historical archive of years 2008-2021, before the migration to mailman3.
A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.
fixeria gerrit-no-reply at lists.osmocom.orgfixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/libosmo-netif/+/19937 ) Change subject: stream: add missing Doxygen \return statements to non-void functions ...................................................................... stream: add missing Doxygen \return statements to non-void functions Change-Id: I693939946497ad08f45cab238a56ceee29578056 --- M src/stream.c 1 file changed, 9 insertions(+), 3 deletions(-) git pull ssh://gerrit.osmocom.org:29418/libosmo-netif refs/changes/37/19937/1 diff --git a/src/stream.c b/src/stream.c index 5f171ea..fc51a49 100644 --- a/src/stream.c +++ b/src/stream.c @@ -289,6 +289,7 @@ /*! \brief Check if Osmocom Stream Client is in connected state * \param[in] cli Osmocom Stream Client + * \return true if connected, false otherwise */ bool osmo_stream_cli_is_connected(struct osmo_stream_cli *cli) { @@ -429,7 +430,9 @@ /*! \brief Create an Osmocom stream client * \param[in] ctx talloc context from which to allocate memory * This function allocates a new \ref osmo_stream_cli and initializes - * it with default values (5s reconnect timer, TCP protocol) */ + * it with default values (5s reconnect timer, TCP protocol) + * \return allocated stream client, or NULL in case of error + */ struct osmo_stream_cli *osmo_stream_cli_create(void *ctx) { struct osmo_stream_cli *cli; @@ -644,6 +647,7 @@ * Open connection of an Osmocom stream client * \param[in] cli Stream Client to connect * \param[in] reconect 1 if we should not automatically reconnect + * \return negative on error, 0 on success */ int osmo_stream_cli_open2(struct osmo_stream_cli *cli, int reconnect) { @@ -716,7 +720,8 @@ /*! \brief Open connection of an Osmocom stream client * By default the client will automatically reconnect after default timeout. * To disable this, use osmo_stream_cli_set_reconnect_timeout() before calling this function. - * \param[in] cli Stream Client to connect */ + * \param[in] cli Stream Client to connect + * \return negative on error, 0 on success */ int osmo_stream_cli_open(struct osmo_stream_cli *cli) { int ret; @@ -1044,7 +1049,8 @@ /*! \brief Open the stream server link. This actually initializes the * underlying socket and binds it to the configured ip/port - * \param[in] link Stream Server Link to open */ + * \param[in] link Stream Server Link to open + * \return negative on error, 0 on success */ int osmo_stream_srv_link_open(struct osmo_stream_srv_link *link) { int ret; -- To view, visit https://gerrit.osmocom.org/c/libosmo-netif/+/19937 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmo-netif Gerrit-Branch: master Gerrit-Change-Id: I693939946497ad08f45cab238a56ceee29578056 Gerrit-Change-Number: 19937 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy at sysmocom.de> Gerrit-MessageType: newchange -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20200902/57bc4715/attachment.htm>