Skip to content

Commit c4d6229

Browse files
committed
doc UPDATE nc_ps_poll() doxygen improved
Refs CESNET/netopeer2#1796
1 parent e006f83 commit c4d6229

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

src/session_server.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -352,23 +352,23 @@ uint16_t nc_ps_session_count(struct nc_pollsession *ps);
352352
* @brief Poll sessions and process any received RPCs.
353353
*
354354
* Only one event on one session is handled in one function call. If this event
355-
* is a session termination (#NC_PSPOLL_SESSION_TERM returned), the session
355+
* is a session termination (::NC_PSPOLL_SESSION_TERM returned), the session
356356
* should be removed from @p ps.
357357
*
358358
* @param[in] ps Pollsession structure to use.
359359
* @param[in] timeout Poll timeout in milliseconds. 0 for non-blocking call, -1 for
360-
* infinite waiting.
360+
* infinite waiting. If ::NC_PSPOLL_NOSESSIONS is returned, no waiting is performed at all.
361361
* @param[in] session Session that was processed and that specific return bits concern.
362-
* Can be NULL.
362+
* Can be NULL.
363363
* @return Bitfield of NC_PSPOLL_* macros.
364364
*/
365365
int nc_ps_poll(struct nc_pollsession *ps, int timeout, struct nc_session **session);
366366

367367
/**
368368
* @brief Remove sessions from a pollsession structure and
369-
* call nc_session_free() on them.
369+
* call ::nc_session_free() on them.
370370
*
371-
* Calling this function with @p all false makes sense if nc_ps_poll() returned #NC_PSPOLL_SESSION_TERM.
371+
* Calling this function with @p all false makes sense if ::nc_ps_poll() returned ::NC_PSPOLL_SESSION_TERM.
372372
*
373373
* @param[in] ps Pollsession structure to clear.
374374
* @param[in] all Whether to free all sessions, or only the invalid ones.

0 commit comments

Comments
 (0)