Re: [Doxygen-users] Escaping period character (.)
Brought to you by:
dimitri
From: Robert D. <rcd...@gm...> - 2009-04-03 20:32:15
|
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? > > |