Re: [Doxygen-users] alias example in manual does not work properly

[Dimitri v. H. <di...@st...>]

On Wed, Mar 27, 2002 at 03:03:15PM -0500, Phil Edwards wrote:
> On Wed, Mar 27, 2002 at 09:02:42AM +0100, Alexander Lichius wrote:
> > I found that "bug" too but didn't realized that it is a bug. I tried to
> > define some aliases to include the CVS header verbatim
> > <br>style. So I added the alias section:
> > <br>&nbsp;&nbsp;&nbsp; ALIASES = "cvsid=@version @verbatim" \
> > bsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
> > "endcvsid= @endverbatim"
> > <br>to my doxygen config file. It just behaves like Phil described: the
> > whole documentation block is removed from the generated
> > <br>documentation. When I replace the two commands with the plain verbatim/endverbatim
> > commands everything works fine.

Alexander: please don't send HTML to the mailing list!

> 
> I've gone through and replaced all the the aliases with plain if/endif
> commands, and things are working better.  (Not perfetly, but better.)
> Either the alising code needs to be redone, or the example in the manual
> should be removed.
> 
> It appears (this is only a guess) that the alias replacements are done
> late in the processing.  We just experimented with an alias like
> 
>     "foo=This is some very common text."
> 
> But then the @foo in the documentation blocks goes unnoticed, and the output
> contains an actual "@foo".  Perhaps this is beyond what the aliases were
> originally intended for, since there is no actual Doxygen @ command in
> the replacement text.  Bummer, that could have saved us a lot of typing.  :-)

Please report such behaviour as a bug report to me (or the bug tracker
at sourceforge) and include a real source fragment and the config file.
Don't forget to mention the version of doxygen and the platform you 
are using.

> 
> I briefly looked at the source for 1.2.14, to try and move alias expansion
> earlier in the processing, but couldn't find where to make such a change.

The substitutions are done in the source parsing phase (look for aliasDict in
scanner.l). This should be early enough I suppose.

Regards,
  Dimitri