pushsrc: Add missing annotations
authorCorentin Noël <corentin.noel@collabora.com>
Fri, 26 Nov 2021 09:12:50 +0000 (10:12 +0100)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Tue, 30 Nov 2021 02:28:15 +0000 (02:28 +0000)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1392>

subprojects/gstreamer/libs/gst/base/gstpushsrc.h

index 7dd53b6..d0d8cef 100644 (file)
@@ -70,10 +70,20 @@ struct _GstPushSrc {
 struct _GstPushSrcClass {
   GstBaseSrcClass parent_class;
 
-  /* ask the subclass to create a buffer, the default implementation
-   * uses alloc and fill */
+  /**
+   * GstPushSrcClass::create:
+   * @buf: (inout):
+   *
+   * Ask the subclass to create a buffer, the default implementation will call alloc if
+   * no allocated @buf is provided and then call fill.
+   */
   GstFlowReturn (*create) (GstPushSrc *src, GstBuffer **buf);
-  /* allocate memory for a buffer */
+  /**
+   * GstPushSrcClass::alloc:
+   * @buf: (out):
+   *
+   * Allocate memory for a buffer.
+   */
   GstFlowReturn (*alloc)  (GstPushSrc *src, GstBuffer **buf);
   /* ask the subclass to fill a buffer */
   GstFlowReturn (*fill)   (GstPushSrc *src, GstBuffer *buf);