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 671709 - Markdown backticks produce <code></code> instead of <tt></tt>
Markdown backticks produce <code></code> instead of <tt></tt>
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.0
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
: 671771 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2012-03-09 11:05 UTC by macro
Modified: 2012-05-19 12:26 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Test source code (299 bytes, text/plain)
2012-03-10 10:47 UTC, macro
Details
Test doxygen.config (17 bytes, text/plain)
2012-03-10 10:48 UTC, macro
Details
Screenshot of results demonstrating bug (59.15 KB, image/png)
2012-03-10 10:49 UTC, macro
Details

Description macro 2012-03-09 11:05:45 UTC
Currently, backticks yield <code> tags, which yield block-level formatting in the final HTML output:

Markdown:    `...`
Source HTML: <code>...</code>
Final HTML:  <div class="fragment"><pre class="fragment">...</pre></div>

The problem is, according to the documentation at http://www.stack.nl/~dimitri/doxygen/markdown.html#md_codespan backticks are supposed to yield inline formatting, not block formatting.  That is, text between the backticks should not appear on a new line.

The solution is for the Markdown processor to yield <tt> instead of <code>:

Markdown:    `...`
Source HTML: <tt>...</tt>
Final HTML:  <code>...</code>
Comment 1 Dimitri van Heesch 2012-03-09 21:34:23 UTC
<code>..</code> should not lead to a <div><pre> in the final output.
What you see is probably due to indenting >=4 spaces.  

Can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem?
Comment 2 macro 2012-03-10 10:47:58 UTC
Created attachment 209377 [details]
Test source code
Comment 3 macro 2012-03-10 10:48:29 UTC
Created attachment 209378 [details]
Test doxygen.config
Comment 4 macro 2012-03-10 10:49:34 UTC
Created attachment 209379 [details]
Screenshot of results demonstrating bug
Comment 5 macro 2012-03-10 10:51:14 UTC
Hi Dimitri,

Find attached a test.cs and doxygen.config that demonstrate the bug, plus a screenshot of the results they produce on my machine with doxygen 1.8.0.

Best,
Ron
Comment 6 Dimitri van Heesch 2012-03-10 11:01:55 UTC
Hi Marco,

Thanks for the example.

I now realize <code> behaves differently for C# than it does for C++ (to make it compatible with other C# tools). As a result backticks indeed give the wrong results. I'll use <tt> instead as you suggested.
Comment 7 Dimitri van Heesch 2012-03-10 13:18:07 UTC
*** Bug 671771 has been marked as a duplicate of this bug. ***
Comment 8 Dimitri van Heesch 2012-05-19 12:26:19 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.1. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.