# 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-2000 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.

## 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.

- DoxyGen My patch doxgen-0.4.diff.gz should be obsolete.
- DOC++

### Generate documentation from source code

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

- make doc If you use DoxyGen.
- make doc++ If you use DOC++.

### Tags used in source code

I use the doc++ tags:

/** ... */

Multi line source code documentation.

/// ...

Single line source code documentation.

//@{ or /*@{*/

Grouping.

//@} or /*@}*/

Grouping.

- @name
  Name of file or group.
- @param
  Describes function/macro parameter
- @return
  Describes function return
- @see
  Links to other section

Please read the documentation of the programs.

## 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)

- Write ANSI C.
- Use 8 spaces tabulators.
- Use 4 spaces indention levels.
- Use C++ comments for to end of line comments.
- Use { } also for one statement blocks.

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