caps: Fix documentation

Fix gst_caps_filter_and_map_in_place() documentation, aiming to
gst_caps_maps_in_place() to express their difference.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4933>
This commit is contained in:
Víctor Manuel Jáquez Leal 2023-06-26 12:56:26 +02:00
parent a10e05000d
commit e5d524b338
2 changed files with 6 additions and 8 deletions

View file

@ -6437,10 +6437,9 @@ contained in @caps.</doc>
<method name="filter_and_map_in_place" c:identifier="gst_caps_filter_and_map_in_place" version="1.6">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstcaps.c">Calls the provided function once for each structure and caps feature in the
#GstCaps. In contrast to gst_caps_foreach(), the function may modify the
structure and features. In contrast to gst_caps_filter_and_map_in_place(),
the structure and features are removed from the caps if %FALSE is returned
from the function.
The caps must be mutable.</doc>
structure and features. In contrast to gst_caps_map_in_place(), the structure
and features are removed from the caps if %FALSE is returned from the
function. The caps must be mutable.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstcaps.h"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>

View file

@ -2646,10 +2646,9 @@ gst_caps_map_in_place (GstCaps * caps, GstCapsMapFunc func, gpointer user_data)
*
* Calls the provided function once for each structure and caps feature in the
* #GstCaps. In contrast to gst_caps_foreach(), the function may modify the
* structure and features. In contrast to gst_caps_filter_and_map_in_place(),
* the structure and features are removed from the caps if %FALSE is returned
* from the function.
* The caps must be mutable.
* structure and features. In contrast to gst_caps_map_in_place(), the structure
* and features are removed from the caps if %FALSE is returned from the
* function. The caps must be mutable.
*
* Since: 1.6
*/