CODEWITHSUNDEEP
doxygen
Jellby
Jellby

Reputation: 2694

Doxygen ignoring aliases

I want to define an alias in doxygen. According to the documentation and testimonials, I just add something like this in Doxyfile

ALIASES += sideeffect="\par Side Effects:\n"

and then use @sideeffect in the source code documentation. But I get this message when running doxygen:

/path/to/file.f:12: warning: Found unknown command `\sideeffect'

I tried escaping the quotes and backslashes too:

ALIASES += "sideeffect=\"\\par Side Effects:\\n\""

and with = instead of += (I also make sure the ALIASES option is not defined anywhere else in Doxyfile). Other options are working fine.

Even a simple ALIASES += "foo=bar" does not work (unknown command `\foo').

I'm using doxygen 1.7.6.1 (Ubuntu 12.04), and the Doxyfile created by this version has the ALIASES line, so I guess it should be supported. What could I be doing wrong?

Upvotes: 1

Views: 1571

Answers (1)

Nick
Nick

Reputation: 1413

Try this

ALIASES += "sideeffect = \par \"Side Effects:\" \n"

This worked for me:

\sideeffect This will cause a catastrophic explosion.

It yields:

enter image description here

I am using 1.8.3.1

Upvotes: 0

Related Questions