From 270dd376bc233bc8901d9c32201b863fb080a816 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sf.net>
Date: Tue, 5 Apr 2011 12:05:19 +0300
Subject: [PATCH] docs: fix docuemntation warnings (and reindent)

---
 sys/v4l2/gstv4l2radio.h    |  1 -
 sys/v4l2/gstv4l2src.h      |  5 ++---
 sys/v4l2/gstv4l2xoverlay.c | 32 +++++++++++++++-----------------
 3 files changed, 17 insertions(+), 21 deletions(-)

diff --git a/sys/v4l2/gstv4l2radio.h b/sys/v4l2/gstv4l2radio.h
index f1c99a277f..68b7ec3912 100644
--- a/sys/v4l2/gstv4l2radio.h
+++ b/sys/v4l2/gstv4l2radio.h
@@ -42,7 +42,6 @@ typedef struct _GstV4l2RadioClass GstV4l2RadioClass;
 
 /**
  * GstV4l2Radio:
- * @v4l2object: private #GstV4l2Object
  *
  * Opaque video4linux2 radio tuner element
  */
diff --git a/sys/v4l2/gstv4l2src.h b/sys/v4l2/gstv4l2src.h
index da8341f4e2..0dd794a711 100644
--- a/sys/v4l2/gstv4l2src.h
+++ b/sys/v4l2/gstv4l2src.h
@@ -49,7 +49,6 @@ typedef GstFlowReturn (*GstV4l2SrcGetFunc)(GstV4l2Src * v4l2src, GstBuffer ** bu
 
 /**
  * GstV4l2Src:
- * @pushsrc: parent #GstPushSrc.
  *
  * Opaque object.
  */
@@ -83,7 +82,7 @@ struct _GstV4l2Src
 
   gint     fps_d, fps_n;       /* framerate if device is open */
   GstClockTime duration;       /* duration of one frame */
-  
+
   GstClockTime ctrl_time;
 
   GstV4l2SrcGetFunc get_frame;
@@ -92,7 +91,7 @@ struct _GstV4l2Src
 struct _GstV4l2SrcClass
 {
   GstPushSrcClass parent_class;
-  
+
   GList *v4l2_class_devices;
 };
 
diff --git a/sys/v4l2/gstv4l2xoverlay.c b/sys/v4l2/gstv4l2xoverlay.c
index 2ad5631249..80f114d202 100644
--- a/sys/v4l2/gstv4l2xoverlay.c
+++ b/sys/v4l2/gstv4l2xoverlay.c
@@ -45,7 +45,7 @@ struct _GstV4l2Xv
 {
   Display *dpy;
   gint port, idle_id, event_id;
-  GMutex *mutex;                       /* to serialize calls to X11 */
+  GMutex *mutex;                /* to serialize calls to X11 */
 };
 
 GST_DEBUG_CATEGORY_STATIC (v4l2xv_debug);
@@ -179,7 +179,7 @@ gst_v4l2_xoverlay_stop (GstV4l2Object * v4l2object)
 
 /* should be called with mutex held */
 static gboolean
-get_render_rect (GstV4l2Object * v4l2object, GstVideoRectangle *rect)
+get_render_rect (GstV4l2Object * v4l2object, GstVideoRectangle * rect)
 {
   GstV4l2Xv *v4l2xv = v4l2object->xv;
   if (v4l2xv && v4l2xv->dpy && v4l2object->xwindow_id) {
@@ -197,8 +197,8 @@ get_render_rect (GstV4l2Object * v4l2object, GstVideoRectangle *rect)
 }
 
 gboolean
-gst_v4l2_xoverlay_get_render_rect (GstV4l2Object *v4l2object,
-    GstVideoRectangle *rect)
+gst_v4l2_xoverlay_get_render_rect (GstV4l2Object * v4l2object,
+    GstVideoRectangle * rect)
 {
   GstV4l2Xv *v4l2xv = v4l2object->xv;
   gboolean ret = FALSE;
@@ -272,7 +272,7 @@ event_refresh (gpointer data)
        * interesting.
        */
       while (XCheckWindowEvent (v4l2xv->dpy, v4l2object->xwindow_id,
-          PointerMotionMask, &e)) {
+              PointerMotionMask, &e)) {
         switch (e.type) {
           case MotionNotify:
             pointer_x = e.xmotion.x;
@@ -307,18 +307,16 @@ event_refresh (gpointer data)
             GST_DEBUG_OBJECT (v4l2object->element,
                 "button %d pressed over window at %d,%d",
                 e.xbutton.button, e.xbutton.x, e.xbutton.y);
-            gst_navigation_send_mouse_event (
-                GST_NAVIGATION (v4l2object->element),
-                "mouse-button-press", e.xbutton.button,
+            gst_navigation_send_mouse_event (GST_NAVIGATION
+                (v4l2object->element), "mouse-button-press", e.xbutton.button,
                 e.xbutton.x, e.xbutton.y);
             break;
           case ButtonRelease:
             GST_DEBUG_OBJECT (v4l2object->element,
                 "button %d released over window at %d,%d",
                 e.xbutton.button, e.xbutton.x, e.xbutton.y);
-            gst_navigation_send_mouse_event (
-                GST_NAVIGATION (v4l2object->element),
-                "mouse-button-release", e.xbutton.button,
+            gst_navigation_send_mouse_event (GST_NAVIGATION
+                (v4l2object->element), "mouse-button-release", e.xbutton.button,
                 e.xbutton.x, e.xbutton.y);
             break;
           case KeyPress:
@@ -334,8 +332,7 @@ event_refresh (gpointer data)
             GST_DEBUG_OBJECT (v4l2object->element,
                 "key %d pressed over window at %d,%d (%s)",
                 e.xkey.keycode, e.xkey.x, e.xkey.y, key_str);
-            gst_navigation_send_key_event (
-                GST_NAVIGATION (v4l2object->element),
+            gst_navigation_send_key_event (GST_NAVIGATION (v4l2object->element),
                 e.type == KeyPress ? "key-press" : "key-release", key_str);
             break;
           default:
@@ -421,9 +418,11 @@ gst_v4l2_xoverlay_set_window_handle (GstV4l2Object * v4l2object, guintptr id)
 
 /**
  * gst_v4l2_xoverlay_prepare_xwindow_id:
- * @param v4l2object
- * @param required TRUE if display is required (ie. TRUE for v4l2sink, but
+ * @v4l2object: the v4l2object
+ * @required: %TRUE if display is required (ie. TRUE for v4l2sink, but
  *   FALSE for any other element with optional overlay capabilities)
+ *
+ * Helper function to create a windo if none is set from the application.
  */
 void
 gst_v4l2_xoverlay_prepare_xwindow_id (GstV4l2Object * v4l2object,
@@ -468,8 +467,7 @@ gst_v4l2_xoverlay_prepare_xwindow_id (GstV4l2Object * v4l2object,
     event_mask = ExposureMask | StructureNotifyMask;
     if (GST_IS_NAVIGATION (v4l2object->element)) {
       event_mask |= PointerMotionMask |
-          KeyPressMask | KeyReleaseMask |
-          ButtonPressMask | ButtonReleaseMask;
+          KeyPressMask | KeyReleaseMask | ButtonPressMask | ButtonReleaseMask;
     }
     XSelectInput (v4l2xv->dpy, win, event_mask);
     v4l2xv->event_id = g_timeout_add (45, event_refresh, v4l2object);