[vlc-devel] [PATCH 1/5] libvlc: document which function was used to the user values

Steve Lhomme robux4 at ycbcr.xyz
Fri May 24 14:12:49 CEST 2019


On 2019-05-24 14:03, Rémi Denis-Courmont wrote:
> Are you sure that this formats properly in the output? IIRC, \see is 
> meant to be within text.

I did not check the output. But \see is used tons of times this way, 
especially in libvlc (but not only). So if the output is wrong is should 
be fixed everywhere else as well.

> Le 24 mai 2019 12:47:27 GMT+03:00, Steve Lhomme <robux4 at ycbcr.xyz> a écrit :
> 
>     ------------------------------------------------------------------------
>       include/vlc/libvlc_dialog.h | 2 +-
>       include/vlc/libvlc_media.h  | 2 ++
>       2 files changed, 3 insertions(+), 1 deletion(-)
> 
>     diff --git a/include/vlc/libvlc_dialog.h b/include/vlc/libvlc_dialog.h
>     index b176b93621..4d5bb95dd7 100644
>     --- a/include/vlc/libvlc_dialog.h
>     +++ b/include/vlc/libvlc_dialog.h
>     @@ -176,7 +176,7 @@ libvlc_dialog_set_context(libvlc_dialog_id *p_id, void *p_context);
>       
>       /**
>        * Return the opaque pointer associated with the dialog id
>     - *
>     + * \see libvlc_dialog_set_context
>        * @version LibVLC 3.0.0 and later.
>        */
>       LIBVLC_API void *
>     diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h
>     index 7b5acc0b24..8122a35e80 100644
>     --- a/include/vlc/libvlc_media.h
>     +++ b/include/vlc/libvlc_media.h
>     @@ -737,6 +737,8 @@ LIBVLC_API void
>        * Get media descriptor's user_data. user_data is specialized data
>        * accessed by the host application, VLC.framework uses it as a pointer to
>        * an native object that references a libvlc_media_t pointer
>     + *
>     + * \see libvlc_media_set_user_data
>        *
>        * \param p_md media descriptor object
>        */
> 
> 
> -- 
> Envoyé de mon appareil Android avec Courriel K-9 Mail. Veuillez excuser 
> ma brièveté.
> 
> _______________________________________________
> vlc-devel mailing list
> To unsubscribe or modify your subscription options:
> https://mailman.videolan.org/listinfo/vlc-devel
> 


More information about the vlc-devel mailing list