Since the code I'm putting in \code blocks is only example code, I'll just
remove the "special comments" indicators so Doxygen will leave those comments
in place.
That will keep the normal "STRIP" behavior in the normal code.
From: Broida, Michael
Sent: Friday, July 06, 2012 1:31 PM
To: 'Eeyore'
Cc: doxygen-users@lists.sourceforge.net
Subject: RE: [Doxygen-users] How to keep C++ comments in "\code" secctions?
Yes, that looks like the culprit. I have it set to "YES". I -could- change
that.
But is there a way to override that setting within a single \page block? Or
even within a single \code block?
Within the normal code files, Doxygen will remove those special comments and
add the appropriate documentation. That's good.
But when I'm quoting example code inside a \page, I want to keep -all- the
comments.
Using \verbatim instead of \code almost works: it keeps the comments, but I
lose -all- the syntax-highlighting.
Am I trying to stretch Doxygen too far?
From: Eeyore [mailto:eey...@monsterworks.com]
Sent: Friday, July 06, 2012 12:48 PM
To: Broida, Michael
Cc: doxygen-users@lists.sourceforge.net
Subject: Re: [Doxygen-users] How to keep C++ comments in "\code" secctions?
I think this is the configuration setting you want to adjust:
STRIP_CODE_COMMENTS
Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct doxygen
to hide any special comment blocks from generated source code fragments. Normal
C and C++ comments will always remain visible.
Aaron
On Jul 6, 2012, at 10:33 AM,
<michael.bro...@thomsonreuters.com<mailto:michael.bro...@thomsonreuters.com>>
<michael.bro...@thomsonreuters.com<mailto:michael.bro...@thomsonreuters.com>>
wrote:
When I use \code{.cpp} inside a \page, it strips out all of the comments that
look like Doxygen comments. For instance, this in a \page \code{.cpp} block:
class XYZ {
public:
DVLMessageFormatter() {}
/**
* @brief This function is called when a DVL restart has been triggered.
The
* formatter should then send all necessary messages to DVL to
* completely refresh its cache.
*/
virtual void HandleDVLRestart() = 0;
}
shows up in the Doxygen output as:
class XYZ {
public:
DVLMessageFormatter() {}
virtual void HandleDVLRestart() = 0;
}
I -want- those comments to remain in the Doxygen output.
How can I do that? I've tried:
· escaping (backslash) the "\*" - nogo
· escaping (backslash) the "@brief" - nogo
Ideas??
Mike
This email was sent to you by Thomson Reuters, the global news and information
company. Any views expressed in this message are those of the individual
sender, except where the sender specifically states them to be the views of
Thomson Reuters.
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats.
http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net<mailto:Doxygen-users@lists.sourceforge.net>
https://lists.sourceforge.net/lists/listinfo/doxygen-users
This email was sent to you by Thomson Reuters, the global news and information
company. Any views expressed in this message are those of the individual
sender, except where the sender specifically states them to be the views of
Thomson Reuters.------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
