New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terminating C comments within markdown files breaks aliases (Origin: bugzilla #709706) #5308

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.8.5 on platform Other
Assigned to: Dimitri van Heesch

On 2013-10-09 05:31:47 +0000, Tim wrote:

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

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

 (and 
) prevents the first warning from being generated, but the following 5 still do.

On 2013-10-12 16:47:13 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2013-12-24 18:58:35 +0000, Dimitri van Heesch wrote:

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).

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment