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 311052 - Can't have trademark symbol in documentation
Can't have trademark symbol in documentation
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.4.x
Other All
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2005-07-20 19:21 UTC by Richard Gillam
Modified: 2008-09-07 13:35 UTC
See Also:
GNOME target: ---
GNOME version: 2.1/2.2



Description Richard Gillam 2005-07-20 19:21:47 UTC
The HTML entity "™" (referring to Unicode U+2122, the superscript TM 
trademark symbol) isn't supported by Doxygen.  It looks like Doxygen intended 
to support this symbol, but did so with the entity string "&tm;", which isn't 
a recognized entity name in HTML at all.  Using "&tm;" in doc comments just 
results in the literal characters "&tm;" appearing in the rendered HTML (in 
Internet Explorer 6, anyway).

I was able to fix this problem in my private copy of Doxygen with two one-line 
changes:

In docparser.cpp, insert the following before line 1274:

  else if (symName=="™") return DocSymbol::Tm;

[this is in DocSymbol::decodeSymbol()]

In htmldocvisitor.cpp, change line 102 as follows:

    case DocSymbol::Tm:      m_t << "&trade;"; break;

[this is in HtmlDocVisitor::visit(DocSymbol*)]

I noticed a related bug in the database: bug #162041, opened by George Rhoten, 
asking for full support of all HTML entities and numeric character 
references.  That would be a more complete solution than what I'm suggesting 
above, and I'd like to second that request.  But the change I propose here 
will at least solve my biggest problem while we're all waiting for a more 
complete solution.
Comment 1 Bernd Giesen 2006-05-03 08:00:41 UTC
I can confirm this behaviour! One way to help yourself without the necessity to appropriately modify and recompile the sources is to use the construct

\htmlonly&trade;\endhtmlonly

in your comment block.
Comment 2 Dimitri van Heesch 2008-09-07 13:35:40 UTC
This has been added in the meantime, so I'll close this bug.