[gstreamer-bugs] [Bug 321269] add sunaudio to 0.9

[GStreamer (bugzilla.gnome.org)]

Do not reply to this via email (we are currently unable to handle email
responses and they get discarded).  You can add comments to this bug at
http://bugzilla.gnome.org/show_bug.cgi?id=321269
 GStreamer | gst-plugins-good | Ver: HEAD CVS





------- Additional Comments From Brian Cameron  2005-11-25 21:07 -------

Okay, I converted the code to use GST_DEBUG_OBJECT and it seems to still work
fine.  I started adding comments, but need a bit more clarification since it
isn't clear to me what you want.  Sorry.

I'm assuming that I do not need to write gtk-doc style docs for functions that
are just implementing interfaces defined in various base classes.  For example,
the gst_sunaudiosink_prepare, gst_sunaudiosink_unprepare, etc.  These are just
static functions defined in the c-file and implement interfaces that I'm
guessing should be explained in the base class gtk-docs (though I notice that
they are not).

I'm guessing I just need to provide documentation for any new interfaces I
expose in the header files.  There really aren't too many of them, and they are
all pretty trivial functions, including the following 3:

in gstsunaudiomixer.h:

  gst_sunaudiomixer_new
  gst_sunaudiomixer_free

in gstsunaudiomixertrack.h:

   gst_sunaudiomixer_track_new

I'm assuming I don't have to provide docs for the various (*_get_type)
interfaces (gst_sunaudio_mixer_element_get_type in gstsunaudiomixerelement.h,
gst_sunaudiomixer_track_get_type in gstsunaudiomixertrack.h, and 
gst_sunaudiosink_get_type in gstsunaudiosink.h.  I think it is normal convention 
to not document get_type functions.  Though I can document them if you want.

Is this correct, that you just want me to provide gtk-docs for the 2 *_new() and
1 *_free() functions listed above, or do you want more?



------- You are receiving this mail because: -------
You are the assignee for the bug.
You are the QA contact for the bug.