diff options
author | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2007-01-28 22:49:26 +0000 |
---|---|---|
committer | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2007-01-28 22:49:26 +0000 |
commit | 457ce3e7b4a869f92d8aef31bdee1b6793587a93 (patch) | |
tree | c62c4939d5669b7d3deb0fb37933a844a32bf1d3 /src/main.h | |
parent | 05bdb92c267e3f041788f2aa41a73c9953249e7c (diff) | |
download | mana-client-457ce3e7b4a869f92d8aef31bdee1b6793587a93.tar.gz mana-client-457ce3e7b4a869f92d8aef31bdee1b6793587a93.tar.bz2 mana-client-457ce3e7b4a869f92d8aef31bdee1b6793587a93.tar.xz mana-client-457ce3e7b4a869f92d8aef31bdee1b6793587a93.zip |
Some work on documentation.
Diffstat (limited to 'src/main.h')
-rw-r--r-- | src/main.h | 29 |
1 files changed, 29 insertions, 0 deletions
@@ -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 <string> #ifdef HAVE_CONFIG_H |