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 734142 - Adding documentation to GstCheck gst_check_setup_src function
Adding documentation to GstCheck gst_check_setup_src function
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
git master
Other Linux
: Normal enhancement
: 1.5.1
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2014-08-01 20:39 UTC by tiagokatcipis
Modified: 2014-08-02 23:30 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Patch that adds documentation to GstCheck (2.91 KB, patch)
2014-08-01 20:39 UTC, tiagokatcipis 		committed Details | Review

Description tiagokatcipis 2014-08-01 20:39:24 UTC 
Created attachment 282291 [details] [review]
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.
Comment 1 Tim-Philipp Müller 2014-08-02 23:29:47 UTC 
Thanks for the patch (there's a special place in heaven for people who submit documentation patches!), pushed:

commit 91045ccd8392d2be7fffce11bfdfa28abc4f69b9
Author: Tiago Cesar Katcipis <tiago.katcipis@digitro.com.br>
Date:   Fri Aug 1 17:27:39 2014 -0300

    gstcheck: add docs for gst_check_setup_src_pad_by_name()
    
    https://bugzilla.gnome.org/show_bug.cgi?id=734142