RE: [FR-devel] Standard source code header.

[Curt Hibbs]

Laurent Julliard wrote:
> Everybody knows what to expect from a README file and I don't think 
> necessary to clutter the introductory header of each source file with 
> redundant information.
> 
> The goal of this header is really sort of legal: say who the author is 
> and to which "entity" this file belong to.
> 
> On a second thought the header should not say "Written by"  but should 
> have a Copyright Statement. This is because we do not belong to an 
> entity to which we can assign the Copyright so we must keep it the 
> individual level.
> 
> So the header should be something like this:
> 
> # Purpose: what this file is all about (2-3 lines maximum)
> # ....
> # $Id$   (<- CVS standard header for version number and date)
> #
> # Copyright (C) Year, Author's name  <email>. All rights reserved.
> # Modified by: Author's name <email>
> #
> # This file is part of the FreeRIDE project
> #
> # This application is free software; you can redistribute it and/or
> # modify it under the terms of the Ruby license defined in the
> # COPYING file.
> #

Sounds good to me.

Curt