Re: [Doxygen-users] Using one comment as both @brief and @file

[Zach R. <zac...@gm...>]

Martin,

Thanks for the response. I realized that making the file and brief comments
the same was a bad idea, and opted to use two different paragraphs for each.
Although, if the only thing I have in a file is a class, why should I have
to have both a file and a brief to have the documentation show up under the
file listing and the class listing? (I'm writing in C++).

Thanks,
Zach

On Tue, Jul 27, 2010 at 11:54 PM, Martin K. Svensson <
mar...@ne...> wrote:

>  What do you mean? The @file command has a @brief comment attached to it.
> Sound like a misunderstanding?
>
> Is it something like this you want to do?
>
> /// @file
> /// @copybrief X
>
>
> /// @brief My comment.
> class X;
>
> --
> Martin Svensson
> SW Developer
> Direct: +46-8-685 04 29
>
> Net Insight AB
> Post:  Box 42093, SE-126 14 STOCKHOLM, SWEDEN
> Visit: Västberga Allé 9, Stockholm
> Web:   http://www.netinsight.net
> Phone: +46-8-685 04 00
> Fax:   +46-8-685 04 20
>
>
> ------------------------------
> *Från:* Zach Rattner
> *Skickat:* ti 2010-07-27 08:33
> *Till:* dox...@li...
> *Ämne:* [Doxygen-users] Using one comment as both @brief and @file
>
> Hi,
>
> I have a paragraph at the top of my h file that I would like to use as both
> the @file and the @brief comment. Is there a way to do this without hacking
> up the source code?
>
> Thanks,
> Zach Rattner
>



-- 
Zach Rattner