[vlc-commits] player: use group to split documentation

[Alexandre Janniaux]

vlc | branch: master | Alexandre Janniaux <ajanni at videolabs.io> | Mon Jun 17 08:44:49 2019 +0200| [643f50eb691e9de44fddb95244b27072c684980f] | committer: Thomas Guillem

player: use group to split documentation

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

 include/vlc_player.h | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)

diff --git a/include/vlc_player.h b/include/vlc_player.h
index e1010decd6..ac85a29d26 100644
--- a/include/vlc_player.h
+++ b/include/vlc_player.h
@@ -974,6 +974,11 @@ struct vlc_player_aout_cbs
 };
 
 /**
+ * \ingroup vlc_player__tracks
+ * @{
+ */
+
+/**
  * Duplicate a track
  *
  * This function can be used to pass a track from a callback to an other
@@ -995,6 +1000,13 @@ vlc_player_track_Dup(const struct vlc_player_track *track);
 VLC_API void
 vlc_player_track_Delete(struct vlc_player_track *track);
 
+/** @} */
+
+/**
+ * \defgroup vlc_player__programs Program control
+ * @{
+ */
+
 /**
  * Duplicate a program
  *
@@ -1014,6 +1026,13 @@ vlc_player_program_Dup(const struct vlc_player_program *prgm);
 VLC_API void
 vlc_player_program_Delete(struct vlc_player_program *prgm);
 
+/** @} */
+
+/**
+ * \defgroup vlc_player__titles Title and chapter control
+ * @{
+ */
+
 /**
  * Hold the title list of the player
  *
@@ -1048,6 +1067,8 @@ vlc_player_title_list_GetCount(vlc_player_title_list *titles);
 VLC_API const struct vlc_player_title *
 vlc_player_title_list_GetAt(vlc_player_title_list *titles, size_t idx);
 
+/** @} */
+
 /**
  * Create a new player instance
  *
@@ -1107,6 +1128,11 @@ VLC_API void
 vlc_player_CondWait(vlc_player_t *player, vlc_cond_t *cond);
 
 /**
+ * \name Player events
+ * @{
+ */
+
+/**
  * Add a listener callback
  *
  * @note Every registered callbacks need to be removed by the caller with
@@ -1132,6 +1158,13 @@ VLC_API void
 vlc_player_RemoveListener(vlc_player_t *player,
                           vlc_player_listener_id *listener_id);
 
+/** @} */
+
+/**
+ * \defgroup vlc_player__playback Playback control
+ * @{
+ */
+
 /**
  * Set the current media
  *
@@ -1592,6 +1625,13 @@ VLC_API enum vlc_player_abloop
 vlc_player_GetAtoBLoop(vlc_player_t *player, vlc_tick_t *a_time, float *a_pos,
                        vlc_tick_t *b_time, float *b_pos);
 
+/** @} */
+
+/**
+ * \defgroup vlc_player__tracks Track control in the current playback
+ * @{
+ */
+
 /**
  * Get the number of tracks for an ES category
  *
@@ -2062,6 +2102,13 @@ vlc_player_ToggleSubtitle(vlc_player_t *player)
     return vlc_player_SetSubtitleEnabled(player, enabled);
 }
 
+/** @} */
+
+/**
+ * \ingroup vlc_player__programs Program control
+ * @{
+ */
+
 /**
  * Get the number of programs
  *
@@ -2231,6 +2278,13 @@ vlc_player_SetTeletextTransparency(vlc_player_t *player, bool enabled);
 VLC_API bool
 vlc_player_IsTeletextTransparent(vlc_player_t *player);
 
+/** @} */
+
+/**
+ * \ingroup vlc_player__titles
+ * @{
+ */
+
 /**
  * Get the title list of the current media
  *
@@ -2381,6 +2435,8 @@ vlc_player_SelectNextChapter(vlc_player_t *player);
 VLC_API void
 vlc_player_SelectPrevChapter(vlc_player_t *player);
 
+/** @} */
+
 /**
  * Add an associated (or external) media to the current media
  *
@@ -2424,6 +2480,11 @@ VLC_API float
 vlc_player_GetAssociatedSubsFPS(vlc_player_t *player);
 
 /**
+ * \defgroup vlc_player__renderer External renderer control
+ * @{
+ */
+
+/**
  * Set the renderer
  *
  * Valid for the current media and all future ones.
@@ -2449,6 +2510,8 @@ vlc_player_SetRenderer(vlc_player_t *player, vlc_renderer_item_t *renderer);
 VLC_API vlc_renderer_item_t *
 vlc_player_GetRenderer(vlc_player_t *player);
 
+/** @} */
+
 /**
  * Navigate (for DVD/Bluray menus or viewpoint)
  *
@@ -2627,6 +2690,8 @@ vlc_player_SetSubtitleTextScale(vlc_player_t *player, unsigned scale);
 VLC_API unsigned
 vlc_player_GetSubtitleTextScale(vlc_player_t *player);
 
+/** @} */
+
 /**
  * Get the signal quality and strength of the current media
  *
@@ -2673,6 +2738,11 @@ VLC_API vlc_object_t *
 vlc_player_GetV4l2Object(vlc_player_t *player) VLC_DEPRECATED;
 
 /**
+ * \defgroup vlc_player__aout Audio output control
+ * @{
+ */
+
+/**
  * Get the audio output
  *
  * @warning The returned pointer must be released with aout_Release().
@@ -2815,6 +2885,15 @@ vlc_player_aout_ToggleMute(vlc_player_t *player)
 VLC_API int
 vlc_player_aout_EnableFilter(vlc_player_t *player, const char *name, bool add);
 
+/** @} */
+
+
+/**
+ * \defgroup vlc_player__vout Video output control
+ * @{
+ */
+
+
 /**
  * Get and hold the main video output
  *
@@ -2977,6 +3056,8 @@ vlc_player_vout_Snapshot(vlc_player_t *player);
 VLC_API void
 vlc_player_vout_OSDMessage(vlc_player_t *player, const char *fmt, ...);
 
+/** @} */
+
 
 /** @} */
 #endif