mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

documentation: improve misleading wording

Browse source 
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>
This commit is contained in:
Vivienne Watermeier 2022-02-23 17:39:18 +01:00 committed by GStreamer Marge Bot
parent 098ff9a453
commit 8cb5d9f49e
3 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-token.c
View file

@ -239,14 +239,14 @@ gst_rtsp_token_get_structure (GstRTSPToken * token)
/**
* gst_rtsp_token_writable_structure:
* @token: The #GstRTSPToken.
* @token: A writable #GstRTSPToken.
*
* Get a writable version of the structure.
*
* Returns: (transfer none): The structure of the token. The structure is still
* owned by the token, which means that you should not free it and that the
* pointer becomes invalid when you free the token. This function checks if
* @token is writable and will never return %NULL.
* pointer becomes invalid when you free the token. This function ensures
* that @token is writable, and if so, will never return %NULL.
*
* MT safe.
*/

6
subprojects/gstreamer/gst/gstevent.c
View file

@ -354,15 +354,15 @@ gst_event_get_structure (GstEvent * event)
/**
* gst_event_writable_structure:
* @event: The #GstEvent.
* @event: A writable #GstEvent.
*
* Get a writable version of the structure.
*
* Returns: (transfer none): The structure of the event. The structure
* is still owned by the event, which means that you should not free
* it and that the pointer becomes invalid when you free the event.
* This function checks if @event is writable and will never return
* %NULL.
* This function ensures that @event is writable, and if so, will
* never return %NULL.
*
* MT safe.
*/

6
subprojects/gstreamer/gst/gstmessage.c
View file

@ -1166,15 +1166,15 @@ gst_message_get_structure (GstMessage * message)
/**
* gst_message_writable_structure:
* @message: The #GstMessage.
* @message: A writable #GstMessage.
*
* Get a writable version of the structure.
*
* Returns: (transfer none): The structure of the message. The structure
* is still owned by the message, which means that you should not free
* it and that the pointer becomes invalid when you free the message.
* This function checks if @message is writable and will never return
* %NULL.
* This function ensures that @message is writable, and if so, will
* never return %NULL.
*
* MT safe.
*