[vlc-commits] interrupt: fix Doxygen (missing head line)

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Mon Jul  6 19:40:23 2015 +0300| [575a19250e5206b29c17f2ab0fd359c8aadee536] | committer: Rémi Denis-Courmont

interrupt: fix Doxygen (missing head line)

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=575a19250e5206b29c17f2ab0fd359c8aadee536
---

 include/vlc_interrupt.h |   17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/include/vlc_interrupt.h b/include/vlc_interrupt.h
index 6e52f4d..eb3c564 100644
--- a/include/vlc_interrupt.h
+++ b/include/vlc_interrupt.h
@@ -45,6 +45,8 @@ struct msghdr;
  */
 
 /**
+ * Interruptible variant of vlc_sem_wait().
+ *
  * Waits on a semaphore like vlc_sem_wait(). If the calling thread has an
  * interruption context (as set by vlc_interrupt_set()), and another thread
  * invokes vlc_interrupt_raise() on that context, the semaphore is incremented.
@@ -61,6 +63,8 @@ struct msghdr;
 VLC_API int vlc_sem_wait_i11e(vlc_sem_t *);
 
 /**
+ * Interruptible variant of poll().
+ *
  * Waits for file descriptors I/O events, a timeout, a signal or a VLC I/O
  * interruption. Except for VLC I/O interruptions, this function behaves
  * just like the standard poll().
@@ -133,9 +137,10 @@ VLC_API void vlc_interrupt_destroy(vlc_interrupt_t *);
 VLC_API vlc_interrupt_t *vlc_interrupt_set(vlc_interrupt_t *);
 
 /**
- * Raises an interruption through a specified context. This is used to
- * asynchronously wake a thread up while it is waiting on some other events
- * (typically I/O events).
+ * Raises an interruption through a specified context.
+ *
+ * This is used to asynchronously wake a thread up while it is waiting on some
+ * other events (typically I/O events).
  *
  * @note This function is thread-safe.
  * @note This function is not a cancellation point.
@@ -143,11 +148,15 @@ VLC_API vlc_interrupt_t *vlc_interrupt_set(vlc_interrupt_t *);
 VLC_API void vlc_interrupt_raise(vlc_interrupt_t *);
 
 /**
- * Marks the interruption context as "killed". This is not reversible.
+ * Marks the interruption context as "killed".
+ *
+ * This is not reversible.
  */
 VLC_API void vlc_interrupt_kill(vlc_interrupt_t *);
 
 /**
+ * Checks if the interruption context was "killed".
+ *
  * Indicates whether the interruption context of the calling thread (if any)
  * was killed with vlc_interrupt_kill().
  */