diff options
| author | Tim-Philipp Müller <tim.muller@collabora.co.uk> | 2009-04-03 11:19:42 +0100 |
|---|---|---|
| committer | Tim-Philipp Müller <tim.muller@collabora.co.uk> | 2009-04-03 11:20:32 +0100 |
| commit | 01166ec0cd11e91a463c3aed2366a1fb0ecbf578 (patch) | |
| tree | 9840e10e5098c1662cd498139e40f5e8ced96683 | |
| parent | 8995a45593dcfde136ef9e3f7d4759ffcffdf2ee (diff) | |
docs: improve API reference for gst_caps_get_structure()
| -rw-r--r-- | gst/gstcaps.c | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/gst/gstcaps.c b/gst/gstcaps.c index b3755f2978..89ad6aa443 100644 --- a/gst/gstcaps.c +++ b/gst/gstcaps.c @@ -793,7 +793,14 @@ gst_caps_get_size (const GstCaps * caps) * WARNING: This function takes a const GstCaps *, but returns a * non-const GstStructure *. This is for programming convenience -- * the caller should be aware that structures inside a constant - * #GstCaps should not be modified. + * #GstCaps should not be modified. However, if you know the caps + * are writable, either because you have just copied them or made + * them writable with gst_caps_make_writable(), you may modify the + * structure returned in the usual way, e.g. with functions like + * gst_structure_set_simple(). + * + * You do not need to free or unref the structure returned, it + * belongs to the #GstCaps. * * Returns: a pointer to the #GstStructure corresponding to @index */ |