[vlc-devel] [PATCH 2/2] Add metadata to libvlc headers about bool params.

[Alexey Sokolov]

---
 bindings/jvlc                     |    2 +-
 bindings/python                   |    2 +-
 doc/Doxyfile.in                   |    1 +
 include/vlc/libvlc_media_player.h |    8 ++++----
 include/vlc/libvlc_vlm.h          |    6 +++---
 5 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/bindings/jvlc b/bindings/jvlc
index 969cee2..9bf16f0 160000
--- a/bindings/jvlc
+++ b/bindings/jvlc
@@ -1 +1 @@
-Subproject commit 969cee2a12b6ffc9e48ab50506abb85e0530f217
+Subproject commit 9bf16f079168204d51e9ee945d32e672d897ab1d
diff --git a/bindings/python b/bindings/python
index 391f638..c9d3b0f 160000
--- a/bindings/python
+++ b/bindings/python
@@ -1 +1 @@
-Subproject commit 391f6383e9568209c3242468c4179645708bdc39
+Subproject commit c9d3b0f6ba4733326276d9b0e06ee9a89fa12aaa
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index bada511..ed30e50 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -181,6 +181,7 @@ TAB_SIZE               = 4
 
 ALIASES                =
 ALIASES += libvlc_return_bool="\if LIBVLC_RETURN_BOOL\n\par LIBVLC_RETURN_BOOL\n\endif"
+ALIASES += libvlc_param_bool=" "
 
 # 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.
diff --git a/include/vlc/libvlc_media_player.h b/include/vlc/libvlc_media_player.h
index 529e0fd..24359aa 100644
--- a/include/vlc/libvlc_media_player.h
+++ b/include/vlc/libvlc_media_player.h
@@ -848,7 +848,7 @@ LIBVLC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi );
  * to reparent it back to its normal parent when disabling fullscreen.
  *
  * \param p_mi the media player
- * \param b_fullscreen boolean for fullscreen status
+ * \param b_fullscreen \libvlc_param_bool boolean for fullscreen status
  */
 LIBVLC_API void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen );
 
@@ -875,7 +875,7 @@ LIBVLC_API int libvlc_get_fullscreen( libvlc_media_player_t *p_mi );
  * \warning This function is only implemented for X11 and Win32 at the moment.
  *
  * \param p_mi the media player
- * \param on true to handle key press events, false to ignore them.
+ * \param on \libvlc_param_bool true to handle key press events, false to ignore them.
  */
 LIBVLC_API
 void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on );
@@ -890,7 +890,7 @@ void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on );
  * \warning This function is only implemented for X11 and Win32 at the moment.
  *
  * \param p_mi the media player
- * \param on true to handle mouse click events, false to ignore them.
+ * \param on \libvlc_param_bool true to handle mouse click events, false to ignore them.
  */
 LIBVLC_API
 void libvlc_video_set_mouse_input( libvlc_media_player_t *p_mi, unsigned on );
@@ -1453,7 +1453,7 @@ LIBVLC_API int libvlc_audio_get_mute( libvlc_media_player_t *p_mi );
  * Set mute status.
  *
  * \param p_mi media player
- * \param status If status is true then mute, otherwise unmute
+ * \param status \libvlc_param_bool If status is true then mute, otherwise unmute
  */
 LIBVLC_API void libvlc_audio_set_mute( libvlc_media_player_t *p_mi, int status );
 
diff --git a/include/vlc/libvlc_vlm.h b/include/vlc/libvlc_vlm.h
index 9573bd8..7226fe7 100644
--- a/include/vlc/libvlc_vlm.h
+++ b/include/vlc/libvlc_vlm.h
@@ -59,7 +59,7 @@ LIBVLC_API void libvlc_vlm_release( libvlc_instance_t *p_instance );
  * \param psz_output the output MRL (the parameter to the "sout" variable)
  * \param i_options number of additional options
  * \param ppsz_options additional options
- * \param b_enabled boolean for enabling the new broadcast
+ * \param b_enabled \libvlc_param_bool boolean for enabling the new broadcast
  * \param b_loop Should this broadcast be played in loop ?
  * \return 0 on success, -1 on error
  */
@@ -77,7 +77,7 @@ LIBVLC_API int libvlc_vlm_add_broadcast( libvlc_instance_t *p_instance,
  * \param psz_input the input MRL
  * \param i_options number of additional options
  * \param ppsz_options additional options
- * \param b_enabled boolean for enabling the new vod
+ * \param b_enabled \libvlc_param_bool boolean for enabling the new vod
  * \param psz_mux the muxer of the vod media
  * \return 0 on success, -1 on error
  */
@@ -178,7 +178,7 @@ LIBVLC_API int libvlc_vlm_set_mux( libvlc_instance_t *p_instance,
  * \param psz_output the output MRL (the parameter to the "sout" variable)
  * \param i_options number of additional options
  * \param ppsz_options additional options
- * \param b_enabled boolean for enabling the new broadcast
+ * \param b_enabled \libvlc_param_bool boolean for enabling the new broadcast
  * \param b_loop Should this broadcast be played in loop ?
  * \return 0 on success, -1 on error
  */
-- 
1.7.3.4