Commit feb55adb authored by Alexey Sokolov's avatar Alexey Sokolov Committed by Rémi Denis-Courmont

Add meta information to libvlc headers.

New doxygen command \libvlc_return_bool means that wrapper generators
should translate returning int to a boolean value.

For example, this is useful for Ruby, where every number, including 0,
is considered to be true.

For normal HTML/LaTeX documentation it's invisible.
Signed-off-by: Rémi Denis-Courmont's avatarRémi Denis-Courmont <remi@remlab.net>
parent 6801a659
......@@ -180,6 +180,7 @@ TAB_SIZE = 4
# You can put \n's in the value part of an alias to insert newlines.
ALIASES =
ALIASES += libvlc_return_bool="\if LIBVLC_RETURN_BOOL\n\par LIBVLC_RETURN_BOOL\n\endif"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
......
......@@ -380,6 +380,8 @@ LIBVLC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
*
* \param p_iter libvlc log iterator or NULL
* \return true if iterator has more message objects, else false
*
* \libvlc_return_bool
*/
LIBVLC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
......
......@@ -459,6 +459,8 @@ libvlc_media_parse_async( libvlc_media_t *p_md );
*
* \param p_md media descriptor object
* \return true if media object has been parsed otherwise it returns false
*
* \libvlc_return_bool
*/
LIBVLC_API int
libvlc_media_is_parsed( libvlc_media_t *p_md );
......
......@@ -96,6 +96,8 @@ LIBVLC_API libvlc_event_manager_t *
*
* \param p_mdis media service discover object
* \return true if running, false if not
*
* \libvlc_return_bool
*/
LIBVLC_API int
libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
......
......@@ -167,6 +167,8 @@ LIBVLC_API int
*
* \param p_ml media list instance
* \return 1 on readonly, 0 on readwrite
*
* \libvlc_return_bool
*/
LIBVLC_API int
libvlc_media_list_is_readonly( libvlc_media_list_t * p_ml );
......
......@@ -179,6 +179,8 @@ LIBVLC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_m
*
* \param p_mi the Media Player
* \return 1 if the media player is playing, 0 otherwise
*
* \libvlc_return_bool
*/
LIBVLC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *p_mi );
......@@ -622,6 +624,8 @@ LIBVLC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *p_m
*
* \param p_mi the Media Player
* \return boolean
*
* \libvlc_return_bool
*/
LIBVLC_API int libvlc_media_player_will_play( libvlc_media_player_t *p_mi );
......@@ -724,6 +728,8 @@ LIBVLC_API unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi );
*
* \param p_mi the media player
* \return true if the media player can seek
*
* \libvlc_return_bool
*/
LIBVLC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi );
......@@ -732,6 +738,8 @@ LIBVLC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi );
*
* \param p_mi the media player
* \return true if the media player can pause
*
* \libvlc_return_bool
*/
LIBVLC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi );
......@@ -794,6 +802,8 @@ LIBVLC_API void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullsc
*
* \param p_mi the media player
* \return the fullscreen status (boolean)
*
* \libvlc_return_bool
*/
LIBVLC_API int libvlc_get_fullscreen( libvlc_media_player_t *p_mi );
......@@ -1379,6 +1389,8 @@ LIBVLC_API void libvlc_audio_toggle_mute( libvlc_media_player_t *p_mi );
*
* \param p_mi media player
* \return the mute status (boolean)
*
* \libvlc_return_bool
*/
LIBVLC_API int libvlc_audio_get_mute( libvlc_media_player_t *p_mi );
......
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