RE: [Doxygen-users] multiline /// comments

[Darren B. <db...@ga...>]

FYI, last I checked, multiline /// comments get cut off in unpredictable
ways for most comment types.  (This isn't a bug, as I recall that the
documentation doesn't claim to support such a multiline comment.)  You won't
get errors or warnings, so you have to examine the output manually.  Only
for describing a structure field does it seem to consistently work:

///
/// I don't trust this
/// comment here.
///
struct xxx {
    /// This works
    /// without problems.
    int y;
};

I've been avoiding /// comments in other contexts for several Doxygen
versions now.  Perhaps this has been fixed since, but I'd be on the lookout.

--Darren

-----Original Message-----
From: Gedalia Pasternak [mailto:ge...@tu...]
Sent: Thursday, January 17, 2002 8:24 AM
To: dox...@li...
Subject: [Doxygen-users] multiline /// comments



Hello all, 
  After poking around the documentation for a while, I found that doxygen
will concatate a multi-line /// comment into the brief description. I was
wondering if there is any way to get doxygen to generate both the brief and
the "more..." comments from multi-line comments. Like it would for /**
comments.  Our project leads really don't like the /** style comments, but
I'm not thrilled with shoving all comments into the brief info block.
  
  Thanks, it's an awesome tool.

-Gedalia Pasternak

---------------------------------------------------------------
Graphics Engineer - www.TurbineGames.com	  
AIM: gedaliap
781.407.4428
---------------------------------------------------------------
Fight Entropy!!!  Fight Entropy!!!  Figth Etnropy! !
iFgth Etnrop!y ! giFth tErno!py !  giFt htrEno!p y! --- Well maybe
not...

_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users