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 731292 - C examples not annotated as C
C examples not annotated as C
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
unspecified
Other Linux
: Normal enhancement
: 1.7.2
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2014-06-05 20:29 UTC by Evan Nemerson
Modified: 2016-02-15 17:52 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
docs: annotate C examples as such (10.46 KB, patch)
2014-06-05 20:29 UTC, Evan Nemerson 		committed Details | Review

Description Evan Nemerson 2014-06-05 20:29:33 UTC 
Created attachment 277971 [details] [review]
docs: annotate C examples as such

Should be |[<!-- language="C" --> instead of |[
Comment 1 Olivier Crête 2014-06-06 19:13:08 UTC 
Which version of gtk-doc where these language annotations added in ? We currently only depend on the very antique 1.12 from 2009... But I wouldn't mind updating our requirement to 1.18 from 2011 or even 1.19 from mid-2013, a year ago.
Comment 2 Evan Nemerson 2014-06-06 20:17:12 UTC 
It was added quite recently (see bug #723118), but I don't think it will break anything.  If I'm reading that right, |[ ... ]| was treated as markup prior to that bug, and <!-- language="C" --> is a comment.

Unfortunately all I have to test with is 1.20.
Comment 3 Tim-Philipp Müller 2014-06-06 20:40:57 UTC 
If we update gtk-doc requirements, let's wait until after 1.4 with that.
Comment 4 Evan Nemerson 2014-06-06 20:53:22 UTC 
I just checked with 1.19, which is from before bug #723118, no problems.  I don't see a need to update the gtk-doc dependency, at least not for this issue.
Comment 5 Luis de Bethencourt 2014-10-06 15:56:06 UTC 
I see no difference when building the documentation with or without the C language annotation. Using gtk-doc 1.19 here.

Should we close this bug?
Comment 6 Tim-Philipp Müller 2015-10-20 16:42:51 UTC 
Evan, what is the significance of this annotation?

Luis says it makes no difference wrt the generated output.
Comment 7 Evan Nemerson 2015-10-20 16:55:41 UTC 
Documentation for languages other than C are being generated from the comments these days.  I know the lack of these annotations was causing problems for valadoc, it is probably an issue for g-ir-doc-tool as well.
Comment 8 Tim-Philipp Müller 2016-02-15 17:52:13 UTC 
Sorry for the delay, thanks for the patch!

 commit d11e657412e657f9a5146680ca8fd703574b63f2
 Author: Evan Nemerson <evan@nemerson.com>
 Date:   Thu Jun 5 13:27:28 2014 -0700

    docs: annotate C examples as such
    
    https://bugzilla.gnome.org/show_bug.cgi?id=731292