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 726941 - docs: Add annotations to support language bindings
docs: Add annotations to support language bindings
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: gst-rtsp-server
git master
Other All
: Normal enhancement
: 1.3.1
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2014-03-23 22:36 UTC by Sebastian Rasmussen
Modified: 2014-03-24 00:40 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Proposed patch adding more annotations to rtsp-server functions. (39.50 KB, patch)
2014-03-23 22:38 UTC, Sebastian Rasmussen 		committed Details | Review

Description Sebastian Rasmussen 2014-03-23 22:36:48 UTC 
Many functions currently lack gtk-doc annotations for arguments and return values which might preclude language bindings from working properly. The attached patch aims to add annotations to most (all?) functions as well as fix some cosmetic typos and indentation changes along the way.
Comment 1 Sebastian Rasmussen 2014-03-23 22:38:12 UTC 
Created attachment 272714 [details] [review]
Proposed patch adding more annotations to rtsp-server functions.
Comment 2 Tim-Philipp Müller 2014-03-24 00:39:51 UTC 
Thanks. I think 95% of these are superfluous (transfer none is default for arguments, and transfer full for constructor functions), but doesn't hurt to make it explicit of course:

commit b1b530157709d09590790da2f439e38c46b2c047
Author: Sebastian Rasmussen <sebras@hotmail.com>
Date:   Sun Mar 23 21:24:48 2014 +0100

    gobject-introspection: Add annotations to support language bindings
    
    In addition a few cosmetic changes:
    
     * Adjust the order of arguments
     * Fix typo: occured -> occurred
     * Fix indentation after Return:-clauses
    
    Fixes https://bugzilla.gnome.org/show_bug.cgi?id=726941