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 789007 - Error in markdown emphasis examples
Error in markdown emphasis examples
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: documentation
1.8.13
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2017-10-15 11:06 UTC by Yannick Duchêne
Modified: 2017-12-25 18:43 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Yannick Duchêne 2017-10-15 11:06:43 UTC 
The page http://www.stack.nl/~dimitri/doxygen/manual/markdown.html has an error about Markdown emphasis. In examples it says:

     single asterisks*

    _single underscores_

      double asterisks**

    __double underscores__

While it should be:

    *single asterisks*

    _single underscores_

    **double asterisks**

    __double underscores__


For some reasons, there are spaces instead of the heading stars. The error seems obviously spotted, but it may confuses some users as much.

The same error appears in the documentation built with 1.8.14-GIT.
Comment 1 Dimitri van Heesch 2017-11-06 19:50:03 UTC 
The problem is actually listed as a limitation on the same page
https://www.doxygen.org/manual/markdown.html#mddox_stars

I'll correct the documentation in the next Git update.
Comment 2 Dimitri van Heesch 2017-12-25 18:43:50 UTC 
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.14. 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 (preferably in the form of a self-contained example).