documentation: improve misleading wording
authorVivienne Watermeier <vwatermeier@igalia.com>
Wed, 23 Feb 2022 16:39:18 +0000 (17:39 +0100)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Thu, 17 Mar 2022 11:56:37 +0000 (11:56 +0000)
commit8cb5d9f49ea03aa0fed022d46462f4f16d5ee6aa
treecfb7a0c27e62e639355aed3f969184659423d66a
parent098ff9a453ae51d3518c9ff0e7c7f1c9f7090e74
documentation: improve misleading wording

The documentation for several gst_*_writable_structure functions stated
that they would never return NULL, without making clear that the passed
object is required to be writable. This changes the wording in those
cases to make that requirement more clear.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1784>
subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-token.c
subprojects/gstreamer/gst/gstevent.c
subprojects/gstreamer/gst/gstmessage.c