From: Sergei Golubchik
Date: April 11 2010 2:27pm
Subject: Re: doxygen comments in header files
List-Archive: http://lists.mysql.com/internals/37861
Message-Id: <20100411142717.GA24100@sergbook.mysql.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii

Hi, Davi!

On Apr 11, Davi Arnaut wrote:
> Hi Timour,
>
> On 4/11/10 12:39 AM, Timour Katchaounov wrote:
>> Guilhem, guys,
>>
>> I'd say, enough theoretical talk. Could each proponent
>> of a specific method of commenting pick some class, and
>> send to the list a sample with comments for both the
>> interface and implementation of few class members.
>> Such an example should contain a complete meaningful
>> description, not just a formal description of parameters
>> and results.
>
> Besides Monty, I think everybody else is in agreement.

No, as a heavy ctags user I prefer the function documentation near the
implementation. With the exception of the public API headers, like
plugin.h or mysql.h.

I'm not going to argue my case though. But I would be happy to know a
solution for ctags users for "documentation in the headers" style.

Regards,
Sergei