Browse Source

vlc_media_library: fix doxygen warnings

include/vlc_media_library.h:658: warning: Unsupported xml/html tag <type> found

    include/vlc_media_library.h:918: warning: argument 'p_handle' of command @param is not found in the argument list of vlc_ml_event_unregister_callback(vlc_medialibrary_t *p_ml, vlc_ml_event_callback_t *p_callback)

    include/vlc_media_library.h:918: warning: The following parameters of vlc_ml_event_unregister_callback(vlc_medialibrary_t *p_ml, vlc_ml_event_callback_t *p_callback) are not documented:
      parameter 'p_ml'
      parameter 'p_callback'

    include/vlc_media_library.h:924: warning: The following parameter of vlc_ml_event_unregister_from_callback(vlc_medialibrary_t *p_ml, vlc_ml_event_callback_t *p_callback) is not documented:
      parameter 'p_ml'

    include/vlc_media_library.h:1530: warning: The following parameter of vlc_ml_list_artists(vlc_medialibrary_t *p_ml, const vlc_ml_query_params_t *params, bool b_include_all) is not documented:
      parameter 'p_ml'
pull/162/head
Alexandre Janniaux 3 years ago
committed by Steve Lhomme
parent
commit
1747fb920f
  1. 11
      include/vlc_media_library.h

11
include/vlc_media_library.h

@ -655,10 +655,10 @@ enum vlc_ml_event_type
{
/**
* Entity modification callbacks. The affected entity will be passed:
* - As a vlc_ml_<type>_t, depending on the type of the modified/inserted
* entity, in vlc_ml_event_t::modification::p_<type>
* - As a `vlc_ml_<type>_t`, depending on the type of the modified/inserted
* entity, in `vlc_ml_event_t::modification::p_<type>`
* for ADDED and UPDATED variants.
* - as an id, in vlc_ml_event_t::deletion::i_entity_id
* - as an id, in ::vlc_ml_event_t::deletion::i_entity_id
* When _DELETED callbacks get invoked, the entity will already have been
* deleted from the database, and cannot be retrieved anymore
*/
@ -916,12 +916,14 @@ vlc_ml_event_register_callback( vlc_medialibrary_t* p_ml, vlc_ml_callback_t cb,
/**
* \brief Unregisters a medialibrary callback
* \param p_handle The handled returned by vlc_ml_register_callback
* \param p_ml an initialized medialibrary instance
* \param p_callback The callback handle returned by vlc_ml_register_callback
*/
VLC_API void vlc_ml_event_unregister_callback( vlc_medialibrary_t* p_ml,
vlc_ml_event_callback_t* p_callback );
/**
* \brief Unregisters a medialibrary callback from the said callback.
* \param p_ml an initialized medialibrary instance
* \param p_callback The handle returned by vlc_ml_register_callback
*
* This must only be called synchronously from the callback function provided to
@ -1533,6 +1535,7 @@ static inline size_t vlc_ml_count_genres( vlc_medialibrary_t* p_ml, const vlc_ml
/**
* @brief vlc_ml_list_artists
* @param p_ml an initialized medialibrary instance
* @param params Query parameters, or NULL for the default
* @param b_include_all True if you wish to fetch artists without at least one album.
* @return

Loading…
Cancel
Save