diff options
| author | Harald Welte <laforge@gnumonks.org> | 2016-04-25 12:11:20 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2016-05-05 18:49:27 +0200 |
| commit | 2d2e2cca0dc1d62addc9c9fcb3a59f343fc3baf6 (patch) | |
| tree | 8ec3ba89d486e4c324d32d1980ce68d5118d2db1 /src/select.c | |
| parent | 0996c879255e4653740814112bf98d0ddc93100c (diff) | |
Update doxygen annotations in libosmocore
This adds and improves doxygen API descriptions all over libosmocore,
reducing the 'white spots' that don't have any documentation.
Diffstat (limited to 'src/select.c')
| -rw-r--r-- | src/select.c | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/select.c b/src/select.c index 02bc2cc3..192cae2f 100644 --- a/src/select.c +++ b/src/select.c @@ -47,6 +47,7 @@ static int unregistered_count; /*! \brief Register a new file descriptor with select loop abstraction * \param[in] fd osmocom file descriptor to be registered + * \returns 0 on success; negative in case of error */ int osmo_fd_register(struct osmo_fd *fd) { @@ -160,6 +161,7 @@ restart: /*! \brief select main loop integration * \param[in] polling should we pollonly (1) or block on select (0) + * \returns 0 if no fd handled; 1 if fd handled; negative in case of error */ int osmo_select_main(int polling) { @@ -189,7 +191,9 @@ int osmo_select_main(int polling) return osmo_fd_disp_fds(&readset, &writeset, &exceptset); } -/*! \brief find an osmo_fd based on the integer fd */ +/*! \brief find an osmo_fd based on the integer fd + * \param[in] fd file descriptor to use as search key + * \returns \ref osmo_fd for \ref fd; NULL in case it doesn't exist */ struct osmo_fd *osmo_fd_get_by_fd(int fd) { struct osmo_fd *ofd; |