[gstreamer-bugs] [Bug 533856] gst_buffer_join() documentation is unclear

[GStreamer (bugzilla.gnome.org)]

If you have any questions why you received this email, please see the text at
the end of this email. Replies to this email are NOT read, please see the text
at the end of this email. You can add comments to this bug at:
  http://bugzilla.gnome.org/show_bug.cgi?id=533856

  GStreamer | gstreamer (core) | Ver: HEAD CVS

Murray Cumming changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEEDINFO                    |UNCONFIRMED




------- Comment #3 from Murray Cumming  2008-05-28 11:09 UTC -------
> Would be great if you could edit/extend the gtk-doc documentation blurb in
> gstutils.c so that it makes sense to you

Done. Thanks for the reminder.

By the way, I notice that some documentation comments in that file use regular
gtk-doc syntax, but some use doxygen/javadoc syntax. I presume gtk-doc somehow
handles both, but it might be something you want to know about.

> > Unrefing of input parameters is generally weird and awkward for language
> > bindings, by the way.

> Well, it's a utility function for C programmers that want to avoid the tedious
> unrefs. You don't have to wrap it if it doesn't make sense in the context of
> your language binding.

So, "span" means the same as "join"? I'll probably add some more documentation
that it's just a way of doing a gst_buffer_span(), and that it's not to be used
by language bindings.


-- 
See http://bugzilla.gnome.org/page.cgi?id=email.html for more info about why you received
this email, why you can't respond via email, how to stop receiving
emails (or reduce the number you receive), and how to contact someone
if you are having problems with the system.

You can add comments to this bug at http://bugzilla.gnome.org/show_bug.cgi?id=533856.