From 457ce3e7b4a869f92d8aef31bdee1b6793587a93 Mon Sep 17 00:00:00 2001 From: Bjørn Lindeijer Date: Sun, 28 Jan 2007 22:49:26 +0000 Subject: Some work on documentation. --- src/main.h | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'src/main.h') diff --git a/src/main.h b/src/main.h index 14f52e4d..6ecf628e 100644 --- a/src/main.h +++ b/src/main.h @@ -24,6 +24,35 @@ #ifndef _TMW_MAIN_H #define _TMW_MAIN_H +/** + * \mainpage + * + * \section Introduction Introduction + * + * This is the documentation for the client of The Mana World + * (http://themanaworld.org). It is always a work in progress, with the intent + * to make it easier for new developers to grow familiar with the source code. + * + * \section General General information + * + * During the game, the current Map is displayed by the main Viewport, which + * is the bottom-most widget in the WindowContainer. Aside the viewport, the + * window container keeps track of all the \link Window Windows\endlink + * displayed during the game. + * + * A Map is composed of several layers of \link Image Images\endlink (tiles), + * a layer with collision information and \link Sprite Sprites\endlink. The + * sprites define the visible part of \link Being Beings\endlink and + * \link FloorItem FloorItems\endlink, they are drawn from top to bottom + * by the map, interleaved with the tiles in the fringe layer. + * + * The server is split up into an \link Net::AccountServer account + * server\endlink, a \link Net::ChatServer chat server\endlink and a \link + * Net::GameServer game server\endlink. There may be multiple game servers. + * Handling of incoming messages is spread over several \link MessageHandler + * MessageHanders\endlink. + */ + #include #ifdef HAVE_CONFIG_H -- cgit v1.2.3-70-g09d2