doxygen-users

[Doxygen-users] Escaping period character (.)

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

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?

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

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

I choose to use Boost.Serialization because that is how the boost
documentation references the different libraries. It by no means is intended
to represent the C++ syntax, it is merely a format of documentation.

On Fri, Apr 3, 2009 at 3:30 PM, Pascal Blanchette
<pa...@ma...>wrote:

>  I know its not exactly what you want to do, but I usually use :: (as in
> Boost::Serialization) to seperate classes and functions. It is a more C++
> notation, but that way Doxygen will generate the links. The Doxygen parser
> is still somewhat C oriented.
>
> Pascal
>
> -----Original Message-----
> *From:* Robert Dailey [mailto:rcd...@gm...]
> *Sent:* Friday, April 03, 2009 4:14 PM
> *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?
>
>

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

[Greg A. <Gre...@do...>]

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.

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

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

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

[Brian B. <Bri...@Ve...>]

<tt>\%ACCUREV_HOME\%\\\.accurev\Logs\ShowTriggers-YYYY-MM-DD.log</tt>

displays correctly when in a \page section as:

%ACCUREV_HOME%\.accurev\Logs\ShowTriggers-YYYY-MM-DD.log

but not in a \brief section where it displays without the separator:

%ACCUREV_HOME%.accurev\Logs\ShowTriggers-YYYY-MM-DD.log




--
View this message in context: http://doxygen.10944.n7.nabble.com/Escaping-period-character-tp3545p6068.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

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

[Brian B. <Bri...@Ve...>]

For those who are interested, just keep adding backslash characters one at a
time and testing each until it displays correctly. This version finally
worked in my case:

...sent to the trigger by AccuRev to
<tt>\%ACCUREV_HOME\%\\\\\\\\.accurev\\Param\\<trigger-command-principal-timestamp\>.xml</tt>
on the machine where the trigger process runs. 

Thanks,
Brian




--
View this message in context: http://doxygen.10944.n7.nabble.com/Escaping-period-character-tp3545p6415.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.