RE: [Doxygen-users] Comment Folding
Brought to you by:
dimitri
|
From: Kris T. <kri...@ic...> - 2001-11-02 00:09:42
|
it works for me... can't see anything wrong except that you should do //!
in your brief comment.
if that wasn't it, are you sure you're processing both .h and .cpp files?
Kris
> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of Christian
> Ratliff
> Sent: 01 November 2001 13:43
> To: dox...@li...
> Subject: [Doxygen-users] Comment Folding
>
>
> doxygen-1.2.11.1
> Windows XP (release)
>
> I noticed that doxygen does not appear to fold together the brief and
> detailed descriptions when producing the documentation. I segment
> my docs as
> follows:
>
> ---foo.h---
>
> class Foo
> {
> // Establishes a connection to the properties database.
> void Bar();
> }
> ---foo.h----
>
> --foo.cpp---
> /**
> * More detailed information about this method without repeating the
> * summary comment.
> *
> * @throws ...
> *
> * @author etc...
> */
> Void Foo::Bar()
> {
> }
> --foo.cpp---
>
> This allows people viewing the header to see the short
> description for the
> method, but reserves the large comment for the source file. It
> also prevents
> having duplicate copies of the same text. I had thought that
> these settings
> would fix it, but no luck:
>
> BRIEF_MEMBER_DESC = YES
> REPEAT_BRIEF = YES
> JAVADOC_AUTOBRIEF = YES
>
> Does anyone already fix this or some advice?
>
> Christian
>
> +-----+
> Christian Ratliff <cra...@de...>
> Sr. Technology Architect / Core Libraries Group
> DeLorme Publishing Co.
> "This is the very perfection of man,
> to find out his own imperfections" - St. Augustine
>
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
|