mirror of
https://github.com/troglobit/libuev.git
synced 2026-10-27 11:40:43 +00:00
Update doc comments to proper doxygen syntax
Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
This commit is contained in:
1 parent
da080c886d
commit
e626d080d7
8 files changed
+138
-85
No files matched your search
+8
-3
@@ -29,6 +29,11 @@
|
||||
#include "uev.h"
|
||||
|
||||
|
||||
/**
|
||||
* Linux [eventfd(2)](https://man7.org/linux/man-pages/man2/eventfd.2.html).
|
||||
* @file event.c
|
||||
*/
|
||||
|
||||
/**
|
||||
* Create a generic event watcher
|
||||
* @param ctx A valid libuEv context
|
||||
@@ -36,7 +41,7 @@
|
||||
* @param cb Callback when an event is posted
|
||||
* @param arg Optional callback argument
|
||||
*
|
||||
* @return POSIX OK(0) or non-zero with @param errno set on error.
|
||||
* @return POSIX OK(0) or non-zero with @p errno set on error.
|
||||
*/
|
||||
int uev_event_init(uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg)
|
||||
{
|
||||
@@ -60,7 +65,7 @@ int uev_event_init(uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg)
|
||||
* Post a generic event
|
||||
* @param w Watcher to post to
|
||||
*
|
||||
* @return POSIX OK(0) or non-zero with @param errno set on error.
|
||||
* @return POSIX OK(0) or non-zero with @p errno set on error.
|
||||
*/
|
||||
int uev_event_post(uev_t *w)
|
||||
{
|
||||
@@ -82,7 +87,7 @@ int uev_event_post(uev_t *w)
|
||||
* Stop a generic event watcher
|
||||
* @param w Watcher to stop
|
||||
*
|
||||
* @return POSIX OK(0) or non-zero with @param errno set on error.
|
||||
* @return POSIX OK(0) or non-zero with @p errno set on error.
|
||||
*/
|
||||
int uev_event_stop(uev_t *w)
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user