Commit 75e737d1 authored by Rémi Duraffort's avatar Rémi Duraffort

libvlc: fix doxygen documentation.

parent 0d430a21
......@@ -64,8 +64,9 @@ extern "C" {
* \param i_options the number of options to add to the item
* \param ppsz_options the options to add to the item
*/
VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
char ** );
VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t *p_instance,
int i_id, int i_options,
char **ppsz_options );
/** @}*/
......
......@@ -122,7 +122,7 @@ const char *libvlc_printerr (const char *fmt, ...);
* \return the libvlc instance or NULL in case of error
*/
VLC_PUBLIC_API libvlc_instance_t *
libvlc_new( int , const char *const * );
libvlc_new( int argc , const char *const *argv );
/**
* Decrement the reference count of a libvlc instance, and destroy it
......@@ -130,7 +130,7 @@ libvlc_new( int , const char *const * );
*
* \param p_instance the instance to destroy
*/
VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance );
/**
* Increments the reference count of a libvlc instance.
......@@ -138,7 +138,7 @@ VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
*
* \param p_instance the instance to reference
*/
VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance );
/**
* Try to start a user interface for the libvlc instance.
......@@ -257,7 +257,7 @@ VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager
/**
* Get an event's type name.
*
* \param i_event_type the desired event
* \param event_type the desired event
*/
VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
......@@ -295,7 +295,7 @@ VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, uns
* \param p_instance libvlc instance
* \return log message instance or NULL on error
*/
VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *);
VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance );
/**
* Close a VLC message log instance.
......@@ -328,7 +328,7 @@ VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
* \param p_log libvlc log instance
* \return log iterator object or NULL on error
*/
VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t * );
VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log );
/**
* Release a previoulsy allocated iterator.
......
......@@ -258,7 +258,7 @@ VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md );
/**
* Duplicate a media descriptor object.
*
* \param p_meta_desc a media descriptor object.
* \param p_md a media descriptor object.
*/
VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md );
......@@ -278,7 +278,7 @@ VLC_PUBLIC_API char * libvlc_media_get_meta( libvlc_media_t *p_md,
*
* \param p_md the media descriptor
* \param e_meta the meta to write
* \param the media's meta
* \param psz_value the media's meta
*/
VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
libvlc_meta_t e_meta,
......
......@@ -68,7 +68,7 @@ VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t
/**
* Get media service discover object its localized name.
*
* \param media discover object
* \param p_mdis media discover object
* \return localized name
*/
VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
......
......@@ -49,11 +49,11 @@ typedef struct libvlc_media_library_t libvlc_media_library_t;
/**
* Create an new Media Library object
*
* \param p_libvlc_instance the libvlc instance
* \param p_instance the libvlc instance
* \return a new object or NULL on error
*/
VLC_PUBLIC_API libvlc_media_library_t *
libvlc_media_library_new( libvlc_instance_t * p_inst );
libvlc_media_library_new( libvlc_instance_t * p_instance );
/**
* Release media library object. This functions decrements the
......
......@@ -47,11 +47,11 @@ typedef struct libvlc_media_list_t libvlc_media_list_t;
/**
* Create an empty media list.
*
* \param p_libvlc libvlc instance
* \param p_instance libvlc instance
* \return empty media list, or NULL on error
*/
VLC_PUBLIC_API libvlc_media_list_t *
libvlc_media_list_new( libvlc_instance_t * );
libvlc_media_list_new( libvlc_instance_t *p_instance );
/**
* Release media list created with libvlc_media_list_new().
......@@ -59,7 +59,7 @@ VLC_PUBLIC_API libvlc_media_list_t *
* \param p_ml a media list created with libvlc_media_list_new()
*/
VLC_PUBLIC_API void
libvlc_media_list_release( libvlc_media_list_t * );
libvlc_media_list_release( libvlc_media_list_t *p_ml );
/**
* Retain reference to a media list
......@@ -67,10 +67,10 @@ VLC_PUBLIC_API void
* \param p_ml a media list created with libvlc_media_list_new()
*/
VLC_PUBLIC_API void
libvlc_media_list_retain( libvlc_media_list_t * );
libvlc_media_list_retain( libvlc_media_list_t *p_ml );
VLC_DEPRECATED_API int
libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
libvlc_media_list_add_file_content( libvlc_media_list_t * p_ml,
const char * psz_uri );
/**
......@@ -79,7 +79,7 @@ VLC_DEPRECATED_API int
* The libvlc_media_list_lock should NOT be held upon entering this function.
*
* \param p_ml a media list instance
* \param p_mi media instance to add
* \param p_md media instance to add
*/
VLC_PUBLIC_API void
libvlc_media_list_set_media( libvlc_media_list_t *p_ml, libvlc_media_t *p_md );
......@@ -100,24 +100,24 @@ VLC_PUBLIC_API libvlc_media_t *
* The libvlc_media_list_lock should be held upon entering this function.
*
* \param p_ml a media list instance
* \param p_mi a media instance
* \param p_md a media instance
* \return 0 on success, -1 if the media list is read-only
*/
VLC_PUBLIC_API int
libvlc_media_list_add_media( libvlc_media_list_t *, libvlc_media_t * );
libvlc_media_list_add_media( libvlc_media_list_t *p_ml, libvlc_media_t *p_md );
/**
* Insert media instance in media list on a position
* The libvlc_media_list_lock should be held upon entering this function.
*
* \param p_ml a media list instance
* \param p_mi a media instance
* \param p_md a media instance
* \param i_pos position in array where to insert
* \return 0 on success, -1 if the media list si read-only
*/
VLC_PUBLIC_API int
libvlc_media_list_insert_media( libvlc_media_list_t *,
libvlc_media_t *, int );
libvlc_media_list_insert_media( libvlc_media_list_t *p_ml,
libvlc_media_t *p_md, int i_pos );
/**
* Remove media instance from media list on a position
......@@ -128,7 +128,7 @@ libvlc_media_list_insert_media( libvlc_media_list_t *,
* \return 0 on success, -1 if the list is read-only or the item was not found
*/
VLC_PUBLIC_API int
libvlc_media_list_remove_index( libvlc_media_list_t *, int );
libvlc_media_list_remove_index( libvlc_media_list_t *p_ml, int i_pos );
/**
* Get count on media list items
......@@ -151,19 +151,19 @@ VLC_PUBLIC_API int
* on the media.
*/
VLC_PUBLIC_API libvlc_media_t *
libvlc_media_list_item_at_index( libvlc_media_list_t *, int );
libvlc_media_list_item_at_index( libvlc_media_list_t *p_ml, int i_pos );
/**
* Find index position of List media instance in media list.
* Warning: the function will return the first matched position.
* The libvlc_media_list_lock should be held upon entering this function.
*
* \param p_ml a media list instance
* \param p_mi media list instance
* \param p_md media list instance
* \return position of media instance
*/
VLC_PUBLIC_API int
libvlc_media_list_index_of_item( libvlc_media_list_t *p_ml,
libvlc_media_t *p_mi );
libvlc_media_t *p_md );
/**
* This indicates if this media list is read-only from a user point of view
......@@ -172,7 +172,7 @@ VLC_PUBLIC_API int
* \return 0 on readonly, 1 on readwrite
*/
VLC_PUBLIC_API int
libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist );
libvlc_media_list_is_readonly( libvlc_media_list_t * p_ml );
/**
* Get lock on media list items
......@@ -180,7 +180,7 @@ VLC_PUBLIC_API int
* \param p_ml a media list instance
*/
VLC_PUBLIC_API void
libvlc_media_list_lock( libvlc_media_list_t * );
libvlc_media_list_lock( libvlc_media_list_t *p_ml );
/**
* Release lock on media list items
......@@ -189,7 +189,7 @@ VLC_PUBLIC_API void
* \param p_ml a media list instance
*/
VLC_PUBLIC_API void
libvlc_media_list_unlock( libvlc_media_list_t * );
libvlc_media_list_unlock( libvlc_media_list_t *p_ml );
/**
* Get libvlc_event_manager from this media list instance.
......
......@@ -545,7 +545,7 @@ void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on );
* handled. This is needed for DVD menus to work, as well as a few video
* filters such as "puzzle".
*
* \note See also \func libvlc_video_set_key_input().
* \note See also libvlc_video_set_key_input().
*
* \warning This function is only implemented for X11 at the moment.
*
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment