[Scummvm-devel] Headers: Copyright and description.

[Jonathan Gray]

On Sun, Jan 09, 2005 at 05:14:09PM +0100, Max Horn wrote:
> Now, as somebody else pointed out, the "Scumm Interpreter" bit is a bit 
> misleading. We could change the header to look like this (please, 
> suggest better descriptions if you can think of any :-):
> 
> /* ScummVM - An interpreter for several classic graphical adventure 
> games
>  * Copyright (C) 2004-2005 The ScummVM project
>  * ...
> 
> or even like this, indicating for each file from which part it comes 
> (again, feel free to fill in better text, it's just an example):
> 
> /* ScummVM - An interpreter for several classic graphical adventure 
> games
>  * Module 'scumm' - A ScummVM engine that allows running LucasArts 
> adventures
>  * Copyright (C) 2004-2005 The ScummVM project
>  * ...
> 
> /* ScummVM - An interpreter for several classic graphical adventure 
> games
>  * Module 'sound' - Sound related code shared by all of ScummVM
>  * Copyright (C) 2004-2005 The ScummVM project
>  * ...
> 
> 
> Comments?

Maybe drop the mention of what part it comes from as it should be
pretty obvious already.

Something like the following with an abbreviated description perhaps.

/* ScummVM - Graphical adventure game interpreter
 * Copyright (C) 2004-2005 The ScummVM project