Development for FreeCraft Version 1.17


     ___________		     _________		      _____  __
     \_	  _____/______   ____   ____ \_   ___ \____________ _/ ____\/  |_
      |    __) \_  __ \_/ __ \_/ __ \/    \  \/\_  __ \__  \\   __\\   __\ 
      |     \   |  | \/\  ___/\  ___/\     \____|  | \// __ \|  |   |  |
      \___  /   |__|    \___  >\___  >\______  /|__|  (____  /__|   |__|
	  \/		    \/	   \/	     \/		   \/
    ______________________                           ______________________
			  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"


This file should give you some information to help too develop FreeCraft.

Make and makefiles

Type 'make help' to get an overview what all could be made.

C code documentation

See below: you can use always the source code documentation.

I have prepared some extra documentations:

Source code documentation

Valery Shchedrin has introduced tagged source documentation. I continued to use them.

This programs are required

You need one this programs to generate source code documentation.

Generate documentation from source code

Please compile and install one of the above programs. With this commands you produce the documentations:

Tags used in source code

I use the doc++ tags:

/** ... */

Multi line source code documentation.

/// ...

Single line source code documentation.

//@{ or /*@{*/

Grouping.

//@} or /*@}*/

Grouping.

Please read the documentation of the programs.

Empty C prototype file

//   ___________		     _________		      _____  __
//   \_	  _____/______   ____   ____ \_   ___ \____________ _/ ____\/  |_
//    |    __) \_  __ \_/ __ \_/ __ \/    \  \/\_  __ \__  \\   __\\   __\ 
//    |     \   |  | \/\  ___/\  ___/\     \____|  | \// __ \|  |   |  |
//    \___  /   |__|    \___  >\___  >\______  /|__|  (____  /__|   |__|
//	  \/		    \/	   \/	     \/		   \/
//  ______________________                           ______________________
//			  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.

//@}

Coding style

You can use your own coding style in your own modules. If you fix in other modules, please imitate the coding style of the old coder.

I suggest: (Linux kernel coding style)


All trademarks and copyrights on this page are owned by their respective owners.
The FreeCraft Project