[vlc-devel] [PATCH 05/19] event: change /* to /**
Kartik Ohri
kartikohri13 at gmail.com
Mon Jul 27 16:04:47 CEST 2020
This is for consistency with all other VLC APIs which are
documented with /** instead of /*.
---
include/vlc_events.h | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/include/vlc_events.h b/include/vlc_events.h
index 845dd31ccf..e7cdeeda7e 100644
--- a/include/vlc_events.h
+++ b/include/vlc_events.h
@@ -171,23 +171,23 @@ typedef void ( *vlc_event_callback_t )( const vlc_event_t *, void * );
* Event manager
*****************************************************************************/
-/*
+/**
* p_obj points to the object that owns the event manager, and from
* which events are sent
*/
void vlc_event_manager_init( vlc_event_manager_t * p_em, void * p_obj );
-/*
+/**
* Destroy
*/
void vlc_event_manager_fini( vlc_event_manager_t * p_em );
-/*
+/**
* Send an event to the listener attached to this p_em.
*/
void vlc_event_send( vlc_event_manager_t * p_em, vlc_event_t * );
-/*
+/**
* Add a callback for an event.
*/
VLC_API int vlc_event_attach( vlc_event_manager_t * p_event_manager,
@@ -195,7 +195,7 @@ VLC_API int vlc_event_attach( vlc_event_manager_t * p_event_manager,
vlc_event_callback_t pf_callback,
void *p_user_data );
-/*
+/**
* Remove a callback for an event.
*/
VLC_API void vlc_event_detach( vlc_event_manager_t *p_event_manager,
--
2.25.1
More information about the vlc-devel
mailing list