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 732689 - strange result on a generated html page
strange result on a generated html page
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.20
Other Linux
: Normal normal
: 1.22
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2014-07-03 14:05 UTC by Rafał Mużyło
Modified: 2015-04-25 08:28 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Rafał Mużyło 2014-07-03 14:05:15 UTC
I might be filing this bug prematurely, but the result I see seems odd enough.

I've just noticed on a page from gtk+ 2.24.23 tarball a rather bizarre looking snippet.

Following bit:

 * Parses a textual specification of a color and fill in the
 * <structfield>red</structfield>, <structfield>green</structfield>,
 * and <structfield>blue</structfield> fields of a #GdkColor

gets transformed into:

<p>Parses a textual specification of a color and fill in the</p>
<em class="structfield"><code>red</code></em>, <em class="structfield"><code>green</code></em>,
<p>and <em class="structfield"><code>blue</code></em> fields of a <a class="link" href="gdk2-Colormaps-and-Colors.html#GdkColor" title="GdkColor"><span class="type">GdkColor</span></a>

These spurious extra paragraph tags result in not-quite compliant html, which gets "red, green," string rendered in a separate paragraph.
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2014-07-04 15:45:03 UTC
What gtk-doc version are you using. If it is the latest, it might be related to the mark-down parser addition. Although I don't see why the extra <p> would be added on the 3rd line.

Link to the full source:
https://git.gnome.org/browse/gtk+/tree/gdk/gdkcolor.c?h=gtk-2-24#n323
Comment 2 Rafał Mużyło 2014-07-05 01:43:40 UTC
Well, that's why I said "I might be filing this bug prematurely" - I didn't test it myself, I just took all the info (including version number) straight from the tarball, after I've noticed the problem in devhelp (which btw. has a problem with redraws on my older system, though it might as well be just a problem with xcompmgr) and confirmed it on the online pages.

Markdown seems fine, at least it looks that way on gtk+ 3 page (those use @foo notation).
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2015-01-06 14:07:57 UTC
Indeed the code in
https://git.gnome.org/browse/gtk+/tree/gdk/gdkcolor.c?h=gtk-2-24#n323
gets turned into this xml (colors.xml)
<para>Parses a textual specification of a color and fill in the</para>
<structfield>red</structfield>, <structfield>green</structfield>,
<para>and <structfield>blue</structfield> fields of a

The closing para on the first line is not expected. @Jon can you take a look?
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2015-01-06 14:09:59 UTC
Forgot the link for the output:
https://developer.gnome.org/gdk2/2.24/gdk2-Colormaps-and-Colors.html#gdk-color-parse
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2015-04-25 08:28:58 UTC
commit 96972ae661ff6da487f5f51fae4a30587eb81335
Author: Stefan Sauer <ensonic@users.sf.net>
Date:   Sat Apr 25 10:25:38 2015 +0200

    mkdb: add 'structfield' as a non-block element
    
    Fixes #732689