doc: Add some missing docstrings
authorThibault Saunier <tsaunier@igalia.com>
Mon, 22 Oct 2018 09:44:04 +0000 (11:44 +0200)
committerThibault Saunier <tsaunier@igalia.com>
Mon, 13 May 2019 15:33:49 +0000 (11:33 -0400)
gst/gstcapsfeatures.c
gst/gstelement.h
libs/gst/controller/gsttimedvaluecontrolsource.c

index 2f433a2..d6d0b1e 100644 (file)
@@ -118,6 +118,13 @@ _priv_gst_caps_features_cleanup (void)
   _gst_caps_features_memory_system_memory = NULL;
 }
 
+/**
+ * gst_is_caps_features:
+ *
+ * Checks if @obj is a #GstCapsFeatures
+ *
+ * Returns: %TRUE if @obj is a #GstCapsFeatures %FALSE otherwise
+ */
 gboolean
 gst_is_caps_features (gconstpointer obj)
 {
index 4ebfd09..ceebdf6 100644 (file)
@@ -1016,6 +1016,13 @@ GST_API
 void                    gst_element_lost_state          (GstElement * element);
 
 
+/**
+ * GstElementCallAsyncFunc:
+ * @element: The #GstElement this function has been called against
+ * @user_data: Data passed in the function where that callback has been passed
+ *
+ * Callback prototype used in #gst_element_call_async
+ */
 typedef void          (*GstElementCallAsyncFunc)        (GstElement * element,
                                                          gpointer     user_data);
 GST_API
index 66c82a9..4c406fd 100644 (file)
@@ -81,6 +81,14 @@ gst_control_point_free (GstControlPoint * cp)
   g_slice_free (GstControlPoint, cp);
 }
 
+/**
+ * gst_control_point_copy:
+ * @cp: The control point to copy
+ *
+ * Copies a #GstControlPoint
+ *
+ * Returns: A copy of @cp
+ */
 GstControlPoint *
 gst_control_point_copy (GstControlPoint * cp)
 {