logo       

Re: how to end the effect at the middle of a phrase: msg#00046

text.doxygen.general

Subject: Re: how to end the effect at the middle of a phrase

Ling Li wrote:
Hi, I have a very simple question but could not find the answer either
from the manual or the FAQ.

The problem is, /** blah (blah @a x and @a y) blah */
will not only italicize x and y, but also the closing parenthesis. I
could not find a simple way to tell Doxygen to "end the effect of @a"
just after y. Though /** blah (blah @a x and <em>y</em>) blah */
could work but it is not consistent (since most of the time I would use
@a).

Any thoughts?

Afaik, there's currently no solution for this.
(except the above mentioned and an additional and ugly space)
But there are some similiar problems.
E.g. you want to say "Objects" in a sentence but you want "Object" (w/o "s")
to be a link to the doc of "Object".
"Object s" is ugly and "Object's" is wrong.

Some kind of TeX-like {} might be useful.
Something that doesn't appear in the output but works as a delimiter for
doxygen.


Thomas




-------------------------------------------------------
This SF.NET email is sponsored by:
SourceForge Enterprise Edition + IBM + LinuxWorld = Something 2 See!
http://www.vasoftware.com


<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise