[vlc-devel] [PATCH] Add warning to doxygen about libvlc_wait().

[Rémi Denis-Courmont]

On Wed, 23 Mar 2011 20:19:41 +0600, Alexey Sokolov
<alexey at alexeysokolov.co.cc> wrote:
> libvlc_set_exit_handler()'s doxygen has the warning about libvlc_wait.
> But libvlc_wait() didn't have one about libvlc_set_exit_handler().
> So if user looked to documentation of libvlc_wait, s/he could easily
> miss the warning.

I don't mind the patch, but I don't fully agree with this assertion. As
long as you've read both descriptions, you've got to see the warning. And
you shouldn't be using a function if you didn't read its documentation.

> This fixes it.

There's a typo in the patch.

-- 
Rémi Denis-Courmont
http://www.remlab.net/