introspection: annotate handle_message ownership
authorAlba Mendez <me@alba.sh>
Thu, 3 Jun 2021 23:46:06 +0000 (23:46 +0000)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Fri, 4 Jun 2021 04:48:39 +0000 (04:48 +0000)
(fixup/improvement to !747) Correct the ownership
annotation for `message` in the `handle_message` vfunc,
and remove the equivalent phrase elsewhere (following
rules of !747.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/830>

gst/gstbin.h

index 0292130..ed6f29d 100644 (file)
@@ -165,8 +165,7 @@ struct _GstBin {
  * to update the list of children in the bin.
  *
  * The #GstBinClass::handle_message method can be overridden to implement custom
- * message handling. handle_message takes ownership of the message, just like
- * gst_element_post_message().
+ * message handling.
  *
  * #GstBinClass::deep_element_added will be called when a new element has been
  * added to any bin inside this bin, so it will also be called if a new child
@@ -228,7 +227,7 @@ struct _GstBinClass {
   /**
    * GstBinClass::handle_message:
    * @bin: the #GstBin
-   * @message: the message to be handled
+   * @message: (transfer full): the message to be handled
    *
    * Method to handle a message from the children.
    */