___________ _________ _____ __ \_ _____/______ ____ ____ \_ ___ \____________ _/ ____\/ |_ | __) \_ __ \_/ __ \_/ __ \/ \ \/\_ __ \__ \\ __\\ __\ | \ | | \/\ ___/\ ___/\ \____| | \// __ \| | | | \___ / |__| \___ >\___ >\______ /|__| (____ /__| |__| \/ \/ \/ \/ \/ ______________________ ______________________ T H E W A R B E G I N S FreeCraft - A free fantasy real time strategy game engine
(C) Copyright 1998-2001 by The FreeCraft Project. Distributed under the "Artistic License"
I have prepared some extra documentations:
/** ... */
Multi line source code documentation.
/// ...
Single line source code documentation.
//@{ or /*@{*/
Grouping.
//@} or /*@}*/
Grouping.
// ___________ _________ _____ __ // \_ _____/______ ____ ____ \_ ___ \____________ _/ ____\/ |_ // | __) \_ __ \_/ __ \_/ __ \/ \ \/\_ __ \__ \\ __\\ __\ // | \ | | \/\ ___/\ ___/\ \____| | \// __ \| | | | // \___ / |__| \___ >\___ >\______ /|__| (____ /__| |__| // \/ \/ \/ \/ \/ // ______________________ ______________________ // T H E W A R B E G I N S // FreeCraft - A free fantasy real time strategy game engine // /**@name {filename}.c - {One line description of this file} */ // // (c) Copyright 2001 by {insert your name here} // // $Id: development.html,v 1.12 2001/03/13 16:43:39 johns Exp $ //@{ /*---------------------------------------------------------------------------- -- Includes ----------------------------------------------------------------------------*/ #include <stdio.h> #include "freecraft.h" // More game includes. /*---------------------------------------------------------------------------- -- Variables ----------------------------------------------------------------------------*/ // Global and local variables of this module. /*---------------------------------------------------------------------------- -- Functions ----------------------------------------------------------------------------*/ // Local and global functions of this module. //@}
I suggest: (Linux kernel coding style)