[16448] in Kerberos_V5_Development

home help back first fref pref prev next nref lref last post

Re: standardizing copyright/license notice delimiters in MIT source

daemon@ATHENA.MIT.EDU (Tom Yu)
Thu Nov 4 17:53:45 2010

To: Zhanna Tsitkova <tsitkova@mit.edu>
From: Tom Yu <tlyu@mit.edu>
Date: Thu, 04 Nov 2010 17:53:39 -0400
In-Reply-To: <C12470E5-DC1A-4C9E-8FA7-C306B55873F1@mit.edu> (Zhanna Tsitkova's
	message of "Thu, 4 Nov 2010 12:03:31 -0400")
Message-ID: <ldvlj58bvrw.fsf@cathode-dark-space.mit.edu>
MIME-Version: 1.0
Cc: "krbdev@MIT.EDU" <krbdev@mit.edu>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: krbdev-bounces@mit.edu

Zhanna Tsitkova <tsitkova@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.
_______________________________________________
krbdev mailing list             krbdev@mit.edu
https://mailman.mit.edu/mailman/listinfo/krbdev

home help back first fref pref prev next nref lref last post