[Bug 734142] New: Adding documentation to GstCheck gst_check_setup_src function

[GStreamer (bugzilla.gnome.org)]

https://bugzilla.gnome.org/show_bug.cgi?id=734142
  GStreamer | documentation | git

           Summary: Adding documentation to GstCheck gst_check_setup_src
                    function
    Classification: Platform
           Product: GStreamer
           Version: git
        OS/Version: Linux
            Status: UNCONFIRMED
          Severity: enhancement
          Priority: Normal
         Component: documentation
        AssignedTo: gstreamer-bugs at lists.freedesktop.org
        ReportedBy: tiagokatcipis at gmail.com
         QAContact: gstreamer-bugs at lists.freedesktop.org
     GNOME version: ---


Created an attachment (id=282291)
 View: https://bugzilla.gnome.org/attachment.cgi?id=282291
 Review: https://bugzilla.gnome.org/review?bug=734142&attachment=282291

Patch that adds documentation to GstCheck

I'm writing some plugins and trying my best to test then with GstCheck. After i
understood what gst_check_setup_src and gst_check_setup_sink did it was quite
easy to inject data on my element and check the output. 

But on the beginning it was quite hard to understand how it works, even looking
at examples (i based myself on gst-plugins-base tests). Ultimately i had to
look at the code (the best documentation right? :-) to fully understand how
this worked.

It seems to be a good idea to document these functions better, starting with
the #gst_check_setup_src function.

-- 
Configure bugmail: https://bugzilla.gnome.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.