[vlc-commits] Header coding style fixes

[Olivier Aubert]

vlc | branch: master | Olivier Aubert <contact at olivieraubert.net> | Tue Jul 19 12:40:57 2016 +0200| [6fe0ef67e9951966fc73d8a4c4814e55712277f3] | committer: Olivier Aubert

Header coding style fixes
- put comment after comma to match the rest of the code
- name/doxygen all function parameters
- define struct name in the struct namespace

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=6fe0ef67e9951966fc73d8a4c4814e55712277f3
---

 include/vlc/libvlc_media.h        |    4 ++--
 include/vlc/libvlc_media_player.h |   26 ++++++++++++++------------
 2 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h
index 72fa9fc..15933c5 100644
--- a/include/vlc/libvlc_media.h
+++ b/include/vlc/libvlc_media.h
@@ -274,7 +274,7 @@ typedef enum libvlc_media_parsed_status_t
 /**
  * Type of a media slave: subtitle or audio.
  */
-typedef enum
+typedef enum libvlc_media_slave_type_t
 {
     libvlc_media_slave_type_subtitle,
     libvlc_media_slave_type_audio,
@@ -284,7 +284,7 @@ typedef enum
  * A slave of a libvlc_media_t
  * \see libvlc_media_slaves_get
  */
-typedef struct
+typedef struct libvlc_media_slave_t
 {
     char *                          psz_uri;
     libvlc_media_slave_type_t       i_type;
diff --git a/include/vlc/libvlc_media_player.h b/include/vlc/libvlc_media_player.h
index 2323b4d..79a0b1f 100644
--- a/include/vlc/libvlc_media_player.h
+++ b/include/vlc/libvlc_media_player.h
@@ -1976,16 +1976,16 @@ LIBVLC_API int libvlc_media_player_set_equalizer( libvlc_media_player_t *p_mi, l
  * See \ref libvlc_media_player_set_role()
  */
 typedef enum libvlc_media_player_role {
-    libvlc_role_None = 0 /**< Don't use a media player role */,
-    libvlc_role_Music   /**< Music (or radio) playback */,
-    libvlc_role_Video /**< Video playback */,
-    libvlc_role_Communication /**< Speech, real-time communication */,
-    libvlc_role_Game /**< Video game */,
-    liblvc_role_Notification /**< User interaction feedback */,
-    libvlc_role_Animation /**< Embedded animation (e.g. in web page) */,
-    libvlc_role_Production /**< Audio editting/production */,
-    libvlc_role_Accessibility /**< Accessibility */,
-    libvlc_role_Test /** Testing */,
+    libvlc_role_None = 0, /**< Don't use a media player role */
+    libvlc_role_Music,   /**< Music (or radio) playback */
+    libvlc_role_Video, /**< Video playback */
+    libvlc_role_Communication, /**< Speech, real-time communication */
+    libvlc_role_Game, /**< Video game */
+    liblvc_role_Notification, /**< User interaction feedback */
+    libvlc_role_Animation, /**< Embedded animation (e.g. in web page) */
+    libvlc_role_Production, /**< Audio editting/production */
+    libvlc_role_Accessibility, /**< Accessibility */
+    libvlc_role_Test /** Testing */
 #define libvlc_role_Last libvlc_role_Test
 } libvlc_media_player_role_t;
 
@@ -1994,17 +1994,19 @@ typedef enum libvlc_media_player_role {
  *
  * \version LibVLC 3.0.0 and later.
  *
+ * \param p_mi media player
  * \return the media player role (\ref libvlc_media_player_role_t)
  */
-LIBVLC_API int libvlc_media_player_get_role(libvlc_media_player_t *);
+LIBVLC_API int libvlc_media_player_get_role(libvlc_media_player_t *p_mi);
 
 /**
  * Sets the media role.
  *
+ * \param p_mi media player
  * \param role the media player role (\ref libvlc_media_player_role_t)
  * \return 0 on success, -1 on error
  */
-LIBVLC_API int libvlc_media_player_set_role(libvlc_media_player_t *,
+LIBVLC_API int libvlc_media_player_set_role(libvlc_media_player_t *p_mi,
                                             unsigned role);
 
 /** @} audio */