player: Update and fix up docs a bit

7 files changed, 69 insertions, 26 deletions

diff --git a/docs/lib/gst-player-docs.xml b/docs/lib/gst-player-docs.xml
index 6f157c0..88e3c33 100644
--- a/docs/lib/gst-player-docs.xml
+++ b/docs/lib/gst-player-docs.xml
@@ -13,6 +13,9 @@
   <chapter>
     <xi:include href="xml/gstplayer.xml"/>
     <xi:include href="xml/gstplayer-mediainfo.xml"/>
+    <xi:include href="xml/gstplayer-gmaincontextsignaldispatcher.xml"/>
+    <xi:include href="xml/gstplayer-videooverlayvideorenderer.xml"/>
+    <xi:include href="xml/gstplayer-visualization.xml"/>
   </chapter>
 
   <chapter id="player-hierarchy">
diff --git a/docs/lib/gst-player-sections.txt b/docs/lib/gst-player-sections.txt
index 2b93c0b..5bada67 100644
--- a/docs/lib/gst-player-sections.txt
+++ b/docs/lib/gst-player-sections.txt
@@ -58,12 +58,6 @@ gst_player_set_visualization
 gst_player_set_visualization_enabled
 gst_player_get_current_visualization
 
-GstPlayerVisualization
-gst_player_visualizations_get
-gst_player_visualizations_free
-gst_player_visualization_copy
-gst_player_visualization_free
-
 GstPlayerColorBalanceType
 gst_player_color_balance_type_get_name
 
@@ -77,15 +71,9 @@ gst_player_set_rate
 GstPlayerSignalDispatcher
 GstPlayerSignalDispatcherInterface
 
-gst_player_g_main_context_signal_dispatcher_new
-
 GstPlayerVideoRenderer
 GstPlayerVideoRendererInterface
 
-gst_player_video_overlay_video_renderer_new
-gst_player_video_overlay_video_renderer_get_window_handle
-gst_player_video_overlay_video_renderer_set_window_handle
-
 <SUBSECTION Standard>
 GST_IS_PLAYER
 GST_IS_PLAYER_CLASS
@@ -120,7 +108,13 @@ GST_IS_PLAYER_VIDEO_RENDERER
 GST_PLAYER_VIDEO_RENDERER
 GST_PLAYER_VIDEO_RENDERER_GET_INTERFACE
 gst_player_video_renderer_get_type
+</SECTION>
 
+<SECTION>
+<FILE>gstplayer-gmaincontextsignaldispatcher</FILE>
+gst_player_g_main_context_signal_dispatcher_new
+
+<SUBSECTION Standard>
 GST_PLAYER_G_MAIN_CONTEXT_SIGNAL_DISPATCHER
 GST_PLAYER_G_MAIN_CONTEXT_SIGNAL_DISPATCHER_CAST
 GST_PLAYER_G_MAIN_CONTEXT_SIGNAL_DISPATCHER_CLASS
@@ -130,7 +124,17 @@ GST_IS_PLAYER_G_MAIN_CONTEXT_SIGNAL_DISPATCHER_CLASS
 GST_TYPE_PLAYER_G_MAIN_CONTEXT_SIGNAL_DISPATCHER
 
 gst_player_g_main_context_signal_dispatcher_get_type
+</SECTION>
 
+<SECTION>
+<FILE>gstplayer-videooverlayvideorenderer</FILE>
+GstPlayerVideoOverlayVideoRenderer
+
+gst_player_video_overlay_video_renderer_new
+gst_player_video_overlay_video_renderer_get_window_handle
+gst_player_video_overlay_video_renderer_set_window_handle
+
+<SUBSECTION Standard>
 GST_PLAYER_VIDEO_OVERLAY_VIDEO_RENDERER
 GST_PLAYER_VIDEO_OVERLAY_VIDEO_RENDERER_CAST
 GST_PLAYER_VIDEO_OVERLAY_VIDEO_RENDERER_CLASS
@@ -144,6 +148,18 @@ gst_player_video_overlay_video_renderer_get_type
 </SECTION>
 
 <SECTION>
+<FILE>gstplayer-visualization</FILE>
+GstPlayerVisualization
+gst_player_visualizations_get
+gst_player_visualizations_free
+gst_player_visualization_copy
+gst_player_visualization_free
+
+<SUBSECTION Standard>
+gst_player_visualization_get_type
+</SECTION>
+
+<SECTION>
 <FILE>gstplayer-mediainfo</FILE>
 GstPlayerMediaInfo
 
diff --git a/lib/gst/player/gstplayer-g-main-context-signal-dispatcher.c b/lib/gst/player/gstplayer-g-main-context-signal-dispatcher.c
index 105fb01..c1f57d0 100644
--- a/lib/gst/player/gstplayer-g-main-context-signal-dispatcher.c
+++ b/lib/gst/player/gstplayer-g-main-context-signal-dispatcher.c
@@ -18,6 +18,12 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:gstplayer-gmaincontextsignaldispatcher
+ * @short_description: Player GLib MainContext dispatcher
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -192,7 +198,10 @@ static void
  * gst_player_g_main_context_signal_dispatcher_new:
  * @application_context: (allow-none): GMainContext to use or %NULL
  *
- * Returns: (transfer full):
+ * Creates a new GstPlayerSignalDispatcher that uses @application_context,
+ * or the thread default one if %NULL is used. See gst_player_new_full().
+ *
+ * Returns: (transfer full): the new GstPlayerSignalDispatcher
  */
 GstPlayerSignalDispatcher *
 gst_player_g_main_context_signal_dispatcher_new (GMainContext *
diff --git a/lib/gst/player/gstplayer-media-info.c b/lib/gst/player/gstplayer-media-info.c
index 6d67d71..a42b611 100644
--- a/lib/gst/player/gstplayer-media-info.c
+++ b/lib/gst/player/gstplayer-media-info.c
@@ -18,16 +18,16 @@
  * Boston, MA 02110-1301, USA.
  */
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
 /**
  * SECTION:gstplayer-mediainfo
- * @short_description: GStreamer Player Media Information API
+ * @short_description: Player Media Information
  *
  */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
 #include "gstplayer-media-info.h"
 #include "gstplayer-media-info-private.h"
 
@@ -214,11 +214,15 @@ gst_player_video_info_get_framerate (const GstPlayerVideoInfo * info,
 /**
  * gst_player_video_info_get_pixel_aspect_ratio:
  * @info: a #GstPlayerVideoInfo
+ * @par_n: (out): numerator
+ * @par_d: (out): denominator
+ *
+ * Returns the pixel aspect ratio in @par_n and @par_d
  *
  */
 void
 gst_player_video_info_get_pixel_aspect_ratio (const GstPlayerVideoInfo * info,
-    guint * par_d, guint * par_n)
+    guint * par_n, guint * par_d)
 {
   g_return_if_fail (GST_IS_PLAYER_VIDEO_INFO (info));
 
diff --git a/lib/gst/player/gstplayer-video-overlay-video-renderer.c b/lib/gst/player/gstplayer-video-overlay-video-renderer.c
index a1698d3..ab8894f 100644
--- a/lib/gst/player/gstplayer-video-overlay-video-renderer.c
+++ b/lib/gst/player/gstplayer-video-overlay-video-renderer.c
@@ -18,6 +18,12 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:gstplayer-videooverlayvideorenderer
+ * @short_description: Player Video Overlay Video Renderer
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/lib/gst/player/gstplayer-visualization.c b/lib/gst/player/gstplayer-visualization.c
index 04fd7e6..79976a7 100644
--- a/lib/gst/player/gstplayer-visualization.c
+++ b/lib/gst/player/gstplayer-visualization.c
@@ -19,6 +19,12 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:gstplayer-visualization
+ * @short_description: Player Visualization
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -39,8 +45,7 @@ G_DEFINE_BOXED_TYPE (GstPlayerVisualization, gst_player_visualization,
  * gst_player_visualization_free:
  * @vis: #GstPlayerVisualization instance
  *
- * Frees #GstPlayerVisualization allocated using g_new() or
- * gst_player_visualization_copy().
+ * Frees a #GstPlayerVisualization.
  */
 void
 gst_player_visualization_free (GstPlayerVisualization * vis)
diff --git a/lib/gst/player/gstplayer.c b/lib/gst/player/gstplayer.c
index 63981e7..94892b7 100644
--- a/lib/gst/player/gstplayer.c
+++ b/lib/gst/player/gstplayer.c
@@ -19,13 +19,9 @@
  * Boston, MA 02110-1301, USA.
  */
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
 /**
  * SECTION:gstplayer
- * @short_description: GStreamer Player API
+ * @short_description: Player
  *
  */
 
@@ -42,6 +38,10 @@
  *
  */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
 #include "gstplayer.h"
 #include "gstplayer-signal-dispatcher-private.h"
 #include "gstplayer-video-renderer-private.h"