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 729911 - Using #TypeName in @short_description makes "-" in HTML index disappear
Using #TypeName in @short_description makes "-" in HTML index disappear
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: 1.22
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2014-05-10 09:37 UTC by Jens Georg
Modified: 2015-04-27 19:52 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
xsl: work around a missing mode in the xsl template (1.19 KB, patch)
2015-04-25 06:55 UTC, Stefan Sauer (gstreamer, gtkdoc dev) 		none Details | Review

Description Jens Georg 2014-05-10 09:37:57 UTC 
From GUPnP:

/**
 * SECTION:gupnp-context-manager
 * @short_description: Manages #GUPnPContext objects.
 *
 * A Utility class that takes care of creation and destruction of
 * #GUPnPContext objects for all available network interfaces as they go up
 * (connect) and down (disconnect), respectively.
 *
 */

Results in

 GUPnPContext — Context object wrapping shared networking bits.
GUPnPContextManagerManages GUPnPContext objects. 

(taken from https://developer.gnome.org/gupnp/0.20/)
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2015-04-18 18:13:54 UTC 
It is easy to reproduce, but unfortunately looks like an issue with the docbooks stylesheets :/ The longdash is not added by gtkdoc.

What I can do is to not linkify the short description.
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2015-04-24 21:51:04 UTC 
I think this is the commit that caused the issue:
http://sourceforge.net/p/docbook/code/9206/
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2015-04-25 06:55:30 UTC 
Created attachment 302325 [details] [review]
xsl: work around a missing mode in the xsl template

Fixes #729911
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2015-04-27 19:52:23 UTC 
Pushed for the release.