/***************************************************************************
file : torcsdoc.h
created : Sat Jul 27 14:24:31 CEST 2002
copyright : (C) 2001 by Eric Espié
email : Eric.Espie@torcs.org
version : $Id$
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
/** @file
@author Eric Espie
@version $Id$
*/
#ifndef _SD_DOC_H_
#define _SD_DOC_H_
/**
@defgroup module Dynamic Modules
This is the interface to load/unload the shared libraries (or DLLs).
Two modes are allowed, the access by filename, of the access by entire directory.
When the directory mode is used, the filenames are not known by advance, this
allow more flexibility at runtime.
The generic information can be retrieved, without keeping the DLL loaded.
The gfid parameter is use to differentiate the modules using different includes.
This functionality is not used yet.
This API is not used for shared libraries linked staticaly at compilation time.
*/
/**
@defgroup gui GUI Management.
This is an interface to manage menus.
@note The screen size is fiwed to 640x480 and the origin is in the lower-left corner.
*/
/**
@defgroup img Image Management.
Load and store png images with easy interface.
*/
/**
@defgroup dir Directory Management.
This is used for directory manipulation.
*/
/**
@defgroup params Parameters file management.
The parameters are stored in XML files and accessed only with this API.
The parameters are structured in:
section - containing a familly of parameters on the same topic.
list - containing elements
of numerical attributes and string attributes.
*/
/**
@defgroup paramsfile Parameters File manipulation.
Read, write, merge parameters files.
@ingroup params
*/
/**
@defgroup paramsdata Parameters Data manipulation.
Read, write, merge parameters files.
@ingroup params
*/
/**
@defgroup paramslist Parameters List manipulation.
Read, write, merge parameters files.
@ingroup params
*/
/**
@defgroup screen Screen management.
*/
/**
@defgroup trace Trace management.
Allow the trace in the file trace.txt
*/
/**
@defgroup OS OS dependant functions
OS specific function table
*/
/**
@defgroup definitions Global definitions
This is the global definitions used in the game.
*/
/**
@defgroup trackstruct Tracks Structure
This is the tracks structure definition.
tTrack is the main track structure.
trackSeg is the segment structure.
@ingroup definitions
*/
/**
@defgroup carstruct Cars Structure
This is the cars structure definition.
CarElt is the main car structure.
@ingroup definitions
*/
/**
@defgroup raceinfo Race Information
This is the race information structures definition.
@ingroup definitions
*/
/**
@defgroup robottools Tools for robots.
This is a collection of useful functions for programming a robot.
*/
/**
@defgroup modint Modules interfaces
This is the interfaces for the dynamic modules.
*/
/**
@defgroup tailq Tail Queue Management
This is the management of tail queues.
*/
/**
@defgroup hash Hash tables Management
This is the hash computation API.
*/
/**
@defgroup ctrl Control Device Management
This is the API to use control devices (Keyboard, mouse and joysticks).
*/
/**
@mainpage Welcome to the Speed Dreams documentation !
@section robotlist Robots related documentation.
@section racemanlist Race Managers related documentation.
*/
#endif /* _SD_DOC_H_ */