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 702499 - Add gtk-doc comments to various functions
Add gtk-doc comments to various functions
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: gst-streaming-server
unspecified
Other Linux
: Normal enhancement
: 1.0.0
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2013-06-17 18:16 UTC by Michael Jones
Modified: 2014-11-24 10:09 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Patch file to add doxygen comments. (7.86 KB, patch)
2013-06-17 18:16 UTC, Michael Jones 		needs-work Details | Review
gtk-doc patch (9.30 KB, patch)
2013-06-24 17:55 UTC, Michael Jones 		committed Details | Review

Description Michael Jones 2013-06-17 18:16:02 UTC 
Created attachment 247057 [details] [review]
Patch file to add doxygen comments.

Attached is a patch against

commit a3c05d8c8c1c30ee5c0430c0c331fda434845ecd
Author: David Schleef <ds@schleef.org>
Date:   Thu May 2 12:35:44 2013 -0700

    server: convert to jpeg snapshot replacements


that adds some doxygen comments to the gstreamer streaming server code to assist in understanding the project.
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2013-06-22 16:53:48 UTC 
Review of attachment 247057 [details] [review]:

Please use gtk-doc style or even plain C /* */ style comments. gstreamer is not using doxygen for its api docs.
Comment 2 Michael Jones 2013-06-24 17:55:43 UTC 
Created attachment 247662 [details] [review]
gtk-doc patch

Patch against

commit a3c05d8c8c1c30ee5c0430c0c331fda434845ecd
Author: David Schleef <ds@schleef.org>
Date:   Thu May 2 12:35:44 2013 -0700

    server: convert to jpeg snapshot replacements


To add documentation to some functions using the gtk-doc style.
Comment 3 Tim-Philipp Müller 2014-11-24 01:07:11 UTC 
Pushed, thanks for the patch. Sorry we didn't get to it sooner, seems to have fallen through the cracks.

commit 0f193c739a0c1f8a64e9e955a7c317b796b9a53c
Author: Michael Jones <mike.jones@intechdirect.com>
Date:   Mon Jun 24 17:55:43 2013 +0100

    gss: add gtk-doc blurbs for some functions
    
    https://bugzilla.gnome.org/show_bug.cgi?id=702499