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 709706 - Terminating C comments within markdown files breaks aliases
Terminating C comments within markdown files breaks aliases
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.5
Other All
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2013-10-09 05:31 UTC by Tim
Modified: 2013-12-24 18:58 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Tim 2013-10-09 05:31:47 UTC
Assume these lines are set in a Doxyfile

ALIASES  = "myalias=@if FOO"
ALIASES += "endmyalias=@endif"

Now given the file, foo.md, with the following contents:



Here is some documentation that contains a documented C enum
~~~{.c}
typedef enum {
    ONE = 1,  /* First number */
    TWO = 2  
} Numbers;
~~~

@myalias

A bunch of  commands support by an external tool that looks for "@myalias"
@dofoo
@dobar
@dobaz

@endmyalias



Running doxygen gives the following warnings:
warning: Documentation block ended in the middle of a conditional section!
warning: Found unknown command `\myalias'
warning: Found unknown command `\dofoo'
warning: Found unknown command `\dobar'
warning: Found unknown command `\dobaz'
warning: Found unknown command `\endmyalias'

Doxygen has appeared to discard it's set of known aliases.
Oddly, all other normal command processing works, i.e. I can still use @if and @endif normally

It all happens because a "*/" is encountered in the markdown file. I would of assumed doxygen is parsing the file as markdown, not C/C++ or some other supported programming language.

Also, changing ~~~{.c} to <pre> (and </pre>) prevents the first warning from being generated, but the following 5 still do.
Comment 1 Dimitri van Heesch 2013-10-12 16:47:13 UTC
Confirmed. Should be fixed in the next GIT update.
Comment 2 Dimitri van Heesch 2013-12-24 18:58:35 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.6. 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 (preferrably in the form of a self-contained example).