Re: [Doxygen-users] Escaping period character (.)

[Clemens F. <c....@os...>]

Robert Dailey:
> The documentation states:
> *
> "If JAVADOC_AUTOBRIEF is set to YES in the configuration file, then
> using JavaDoc style comment blocks will automatically start a brief
> description which ends at the first dot
> followed by a space or new line"*
> *
> *
> *I guess this means that Boost.Serialization will not end the brief
> description because it has no trailing space after the period.*
> 


I would agree to Robert:
"brief" means "dot + following space".

There is an old thread about this topic named "how to have periods in 
brief documentation?" from Sat, 27 Oct 2007. Here is what Dimitri has 
pointed out there:

See http://www.doxygen.org/docblocks.html, in particular this example:

/** Brief description (e.g.\ using only a few words). Details follow. */

JAVADOC_AUTOBRIEF:
If you enable this option and want to put a dot in the middle of a 
sentence without ending it, you should put a backslash and a space after it.


Clemens