Changeset 3a101f3a6acb6355f280176aa74b5d437c013876

Show
Ignore:
Timestamp:
04/06/08 17:30:06 (5 months ago)
Author:
Filippo Carone <littlejohn@videolan.org>
git-committer:
Filippo Carone <littlejohn@videolan.org> 1207495806 +0200
git-parent:

[d33acd731f8d13bd6f21823cfad8cadae469b684]

git-author:
Cristian Maglie <megabug@autistici.org> 1207495729 +0200
Message:

libvlc.h: fixed doxygen for log functions. changed prototype for libvlc_log_iterator_next (used typedef'ed version)

Signed-off-by: Filippo Carone <littlejohn@videolan.org>

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • include/vlc/libvlc.h

    r001ec5a r3a101f3  
    7171 * 
    7272 * \param p_exception the exception to raise 
    73  * \param psz_message the exception message format string 
     73 * \param psz_format the exception message format string 
    7474 * \param ... the format string arguments 
    7575 */ 
    …… 
    788788 * \param i_event_type the desired event to which we want to unregister 
    789789 * \param f_callback the function to call when i_event_type occurs 
     790 * \param p_user_data user provided data to carry with the event 
    790791 * \param p_e an initialized exception pointer 
    791792 */ 
    …… 
    879880 * 
    880881 * \param p_instance libvlc instance 
    881  * \param exception an initialized exception pointer 
     882 * \param p_e an initialized exception pointer 
    882883 */ 
    883884VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance, 
    …… 
    887888 * Set the VLC messaging verbosity level. 
    888889 * 
    889  * \param p_log libvlc log instance 
    890  * \param exception an initialized exception pointer 
     890 * \param p_instance libvlc log instance 
     891 * \param level log level 
     892 * \param p_e an initialized exception pointer 
    891893 */ 
    892894VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level, 
    …… 
    897899 * 
    898900 * \param p_instance libvlc instance 
    899  * \param exception an initialized exception pointer 
     901 * \param p_e an initialized exception pointer 
    900902 */ 
    901903VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *); 
    …… 
    905907 * 
    906908 * \param p_log libvlc log instance 
    907  * \param exception an initialized exception pointer 
     909 * \param p_e an initialized exception pointer 
    908910 */ 
    909911VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *); 
    …… 
    913915 * 
    914916 * \param p_log libvlc log instance 
    915  * \param exception an initialized exception pointer 
     917 * \param p_e an initialized exception pointer 
    916918 */ 
    917919VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *); 
    …… 
    924926 * 
    925927 * \param p_log libvlc log instance 
    926  * \param exception an initialized exception pointer 
     928 * \param p_e an initialized exception pointer 
    927929 */ 
    928930VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *); 
    …… 
    932934 * 
    933935 * \param p_log libvlc log instance 
    934  * \param exception an initialized exception pointer 
     936 * \param p_e an initialized exception pointer 
    935937 */ 
    936938VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *); 
    …… 
    939941 * Release a previoulsy allocated iterator. 
    940942 * 
    941  * \param p_log libvlc log iterator 
    942  * \param exception an initialized exception pointer 
     943 * \param p_iter libvlc log iterator 
     944 * \param p_e an initialized exception pointer 
    943945 */ 
    944946VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e ); 
    …… 
    947949 * Return whether log iterator has more messages. 
    948950 * 
    949  * \param p_log libvlc log iterator 
    950  * \param exception an initialized exception pointer 
     951 * \param p_iter libvlc log iterator 
     952 * \param p_e an initialized exception pointer 
    951953 */ 
    952954VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e ); 
    …… 
    957959 * The message contents must not be freed 
    958960 * 
    959  * \param p_log libvlc log iterator 
    960  * \param exception an initialized exception pointer 
     961 * \param p_iter libvlc log iterator 
     962 * \param p_buffer log buffer 
     963 * \param p_e an initialized exception pointer 
    961964 */ 
    962965VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter, 
    963                                                                struct libvlc_log_message_t *buffer, 
     966                                                               libvlc_log_message_t *p_buffer, 
    964967                                                               libvlc_exception_t *p_e ); 
    965968