standardizing copyright/license notice delimiters in MIT source files.
Tom Yu
tlyu at MIT.EDU
Thu Nov 4 17:53:39 EDT 2010
Zhanna Tsitkova <tsitkova at MIT.EDU> writes:
> On Sep 21, 2010, at 2:12 PM, Will Fiveash wrote:
>
>>
>> /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
>> /* prototype/prototype.c */
>
>
> I suggest to add a short comment stating the purpose of the file into
> the second line, i.e :
>
> /* prototype/prototype.c - Short Description */
This is easily adapted for use with Doxygen markup, e.g.
/** @file prototype/prototype.c @brief Short Description here */
or even
/** @file prototype/prototype.c Short Description here */
if the "autobrief" option is turned on.
More information about the krbdev
mailing list