kqueue: Don't use doc comments

This is not public API, so no need to confuse gtk-doc by
documentation that it needs to ignore. Also, no need for
markup in here.
This commit is contained in:
Matthias Clasen 2014-02-01 09:50:23 -05:00
parent 293fdc312c
commit 07506f6c57

View File

@ -48,7 +48,7 @@ const uint32_t KQUEUE_VNODE_FLAGS =
extern int get_kqueue_descriptor(void); extern int get_kqueue_descriptor(void);
/** /*
* _kqueue_thread_collect_fds: * _kqueue_thread_collect_fds:
* @events: a #kevents - the list of events to monitor. Will be extended * @events: a #kevents - the list of events to monitor. Will be extended
* with new items. * with new items.
@ -56,7 +56,7 @@ extern int get_kqueue_descriptor(void);
* Picks up new file descriptors for monitoring from a global queue. * Picks up new file descriptors for monitoring from a global queue.
* *
* To add new items to the list, use _kqueue_thread_push_fd(). * To add new items to the list, use _kqueue_thread_push_fd().
**/ */
static void static void
_kqueue_thread_collect_fds (kevents *events) _kqueue_thread_collect_fds (kevents *events)
{ {
@ -85,7 +85,7 @@ _kqueue_thread_collect_fds (kevents *events)
} }
/** /*
* _kqueue_thread_cleanup_fds: * _kqueue_thread_cleanup_fds:
* @events: a #kevents -- list of events to monitor. Cancelled * @events: a #kevents -- list of events to monitor. Cancelled
* subscriptions will be removed from it, and its size * subscriptions will be removed from it, and its size
@ -97,7 +97,7 @@ _kqueue_thread_collect_fds (kevents *events)
* to cancel monitoring on them. The list will be freed then. * to cancel monitoring on them. The list will be freed then.
* *
* To add new items to the list, use _kqueue_thread_remove_fd(). * To add new items to the list, use _kqueue_thread_remove_fd().
**/ */
static void static void
_kqueue_thread_cleanup_fds (kevents *events) _kqueue_thread_cleanup_fds (kevents *events)
{ {
@ -133,14 +133,14 @@ _kqueue_thread_cleanup_fds (kevents *events)
} }
/** /*
* _kqueue_thread_drop_fd: * _kqueue_thread_drop_fd:
* @events: a #kevents -- list of events to monitor. Cancelled * @events: a #kevents -- list of events to monitor. Cancelled
* subscriptions will be removed from it, and its size * subscriptions will be removed from it, and its size
* probably will be reduced. * probably will be reduced.
* *
* Removes a concrete file descriptor from monitoring. * Removes a concrete file descriptor from monitoring.
**/ */
static void static void
_kqueue_thread_drop_fd (kevents *events, int fd) _kqueue_thread_drop_fd (kevents *events, int fd)
{ {
@ -160,7 +160,7 @@ _kqueue_thread_drop_fd (kevents *events, int fd)
} }
} }
/** /*
* _kqueue_thread_func: * _kqueue_thread_func:
* @arg: a pointer to int -- control file descriptor. * @arg: a pointer to int -- control file descriptor.
* *
@ -169,14 +169,8 @@ _kqueue_thread_drop_fd (kevents *events, int fd)
* and writes the notifications into it. * and writes the notifications into it.
* *
* Control commands are single-byte characters: * Control commands are single-byte characters:
* <itemizedlist> * - 'A' - pick up new file descriptors to monitor
* <listitem> * - 'R' - remove some descriptors from monitoring.
* 'A' - pick up new file descriptors to monitor
* </listitem>
* <listitem>
* 'R' - remove some descriptors from monitoring.
* </listitem>
* </itemizedlist>
* *
* For details, see _kqueue_thread_collect_fds() and * For details, see _kqueue_thread_collect_fds() and
* _kqueue_thread_cleanup_fds(). * _kqueue_thread_cleanup_fds().
@ -185,7 +179,7 @@ _kqueue_thread_drop_fd (kevents *events, int fd)
* are represented with #kqueue_notification objects. * are represented with #kqueue_notification objects.
* *
* Returns: %NULL * Returns: %NULL
**/ */
void* void*
_kqueue_thread_func (void *arg) _kqueue_thread_func (void *arg)
{ {
@ -271,7 +265,7 @@ _kqueue_thread_func (void *arg)
} }
/** /*
* _kqueue_thread_push_fd: * _kqueue_thread_push_fd:
* @fd: a file descriptor * @fd: a file descriptor
* *
@ -280,7 +274,7 @@ _kqueue_thread_func (void *arg)
* The kqueue thread will not start monitoring on it immediately, it * The kqueue thread will not start monitoring on it immediately, it
* should be bumped via its command file descriptor manually. * should be bumped via its command file descriptor manually.
* See kqueue_thread() and _kqueue_thread_collect_fds() for details. * See kqueue_thread() and _kqueue_thread_collect_fds() for details.
**/ */
void void
_kqueue_thread_push_fd (int fd) _kqueue_thread_push_fd (int fd)
{ {
@ -290,7 +284,7 @@ _kqueue_thread_push_fd (int fd)
} }
/** /*
* _kqueue_thread_remove_fd: * _kqueue_thread_remove_fd:
* @fd: a file descriptor * @fd: a file descriptor
* *
@ -300,7 +294,7 @@ _kqueue_thread_push_fd (int fd)
* The kqueue thread will not stop monitoring on it immediately, it * The kqueue thread will not stop monitoring on it immediately, it
* should be bumped via its command file descriptor manually. * should be bumped via its command file descriptor manually.
* See kqueue_thread() and _kqueue_thread_collect_fds() for details. * See kqueue_thread() and _kqueue_thread_collect_fds() for details.
**/ */
void void
_kqueue_thread_remove_fd (int fd) _kqueue_thread_remove_fd (int fd)
{ {