After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 667689 - gststructure: clarify _get docs about the returned reference
gststructure: clarify _get docs about the returned reference
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: gstreamer (core)
unspecified
Other All
: Normal normal
: 0.10.37
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2012-01-11 12:23 UTC by Vincent Penquerc'h
Modified: 2012-01-11 12:57 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
gststructure: clarify _get docs about the returned reference (1.90 KB, patch)
2012-01-11 12:23 UTC, Vincent Penquerc'h
committed Details | Review

Description Vincent Penquerc'h 2012-01-11 12:23:24 UTC
gststructure: clarify _get docs about the returned reference

I was confused by these docs. To me, "you will acquire your own
reference" means "you need to call _ref yourself", whereas what
the code does it give you an already reffed pointer.

Test code shows that a ref is indeed returned (at least for caps,
which is what I tested). I think this is a lot clearer, but then
I'm not a native English speaker so maybe I'm missing a subtlety
here, so I'll put that up for comments before pushing.
Comment 1 Vincent Penquerc'h 2012-01-11 12:23:26 UTC
Created attachment 205016 [details] [review]
gststructure: clarify _get docs about the returned reference
Comment 2 Tim-Philipp Müller 2012-01-11 12:34:39 UTC
Comment on attachment 205016 [details] [review]
gststructure: clarify _get docs about the returned reference

Makes sense and is much clearer IMHO.
Comment 3 Vincent Penquerc'h 2012-01-11 12:57:08 UTC
Thanks. I still had this nagging feeling I might have been missing something :)

commit 98c99630ad55d502cb4e75feb2272dd0d50b92e5
Author: Vincent Penquerc'h <vincent.penquerch@collabora.co.uk>
Date:   Wed Jan 11 12:19:20 2012 +0000

    gststructure: clarify _get docs about the returned reference
    
    https://bugzilla.gnome.org/show_bug.cgi?id=667689