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

[Robert D. <rcd...@gm...>]

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

On Mon, Apr 6, 2009 at 2:35 AM, Greg Aldridge
<Gre...@do...>wrote:

>  http://www.stack.nl/~dimitri/doxygen/docblocks.html
> About a 3rd of the way down.
>
>  -----Original Message-----
> *From:* Robert Dailey [mailto:rcd...@gm...]
> *Sent:* 03 April 2009 21:14
> *To:* doxygen
> *Subject:* [Doxygen-users] Escaping period character (.)
>
> I currently have JAVADOC_AUTOBRIEF enabled and I need to escape a period
> (.) character to prevent it from being parsed by Doxygen as a real period
> ending a sentence. For example, my documentation looks like:
>
> /// This is required by Boost.Serialization.
> virtual char const* get_key() const = 0;
>
> As you can see, the first period is part of the name "Boost.Serialization"
> and does is not meant to indicate the end of the brief description. Can I
> escape the period somehow?
>
> ****************************************************
>
> Visit our website at <http://www.domino-printing.com/>
>
> ****************************************************
>
> This Email and any files transmitted with it are intended only for the
> person or entity to which it is addressed and may contain confidential
> and/or privileged material. Any reading, redistribution, disclosure or other
> use of, or taking of any action in reliance upon, this information by
> persons or entities other than the intended recipient is prohibited. If you
> are not the intended recipient please contact the sender immediately and
> delete the material from your computer.
>
>
>
> E-mail may be susceptible to data corruption, interception, viruses and
> unauthorised amendment and Domino UK Limited does not accept liability for
> any such corruption, interception, viruses or amendment or their
> consequences.
>
> ****************************************************
>
> Domino UK Limited. Registered in England. Registered Number:1750201.
> Registered Office Address: Trafalgar Way, Bar Hill, Cambridge, CB23 8TU.
>
>
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>