summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThorbjørn Lindeijer <thorbjorn@lindeijer.nl>2010-02-23 21:13:22 +0100
committerThorbjørn Lindeijer <thorbjorn@lindeijer.nl>2010-02-23 21:16:50 +0100
commit488f0f0f62624c9bd241ff70b265d15c7e61a7ea (patch)
tree9e65fabc3366f2280d102e07d1c34c8b7fd40d0d
parent4ce429b7f949524b5392d91cf480c933882d15d9 (diff)
downloadmana-client-488f0f0f62624c9bd241ff70b265d15c7e61a7ea.tar.gz
mana-client-488f0f0f62624c9bd241ff70b265d15c7e61a7ea.tar.bz2
mana-client-488f0f0f62624c9bd241ff70b265d15c7e61a7ea.tar.xz
mana-client-488f0f0f62624c9bd241ff70b265d15c7e61a7ea.zip
Updated some documentation
Also added generated documentation to the git ignore list. Reviewed-by: Jared Adams
-rw-r--r--.gitignore3
-rw-r--r--src/main.h15
-rw-r--r--src/net/net.h6
3 files changed, 15 insertions, 9 deletions
diff --git a/.gitignore b/.gitignore
index 5577bfb5..7bca3e65 100644
--- a/.gitignore
+++ b/.gitignore
@@ -70,3 +70,6 @@ GTAGS
# generated for nsis build
translations/*
+
+# documentation generated by Doxygen
+docs/SOURCE/html/*
diff --git a/src/main.h b/src/main.h
index 9848d9b1..03e0c7b3 100644
--- a/src/main.h
+++ b/src/main.h
@@ -27,9 +27,9 @@
*
* \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.
+ * This is the documentation for the Mana client (http://manasource.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
*
@@ -44,11 +44,10 @@
* \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.
+ * The client supports two servers, \link EAthena eAthena\endlink (the TMW
+ * version) and the \link ManaServ Mana server\endlink. To achieve this, the
+ * \link Net network communication layer\endlink is abstracted in many
+ * different interfaces, which have different implementations for each server.
*/
#ifdef HAVE_CONFIG_H
diff --git a/src/net/net.h b/src/net/net.h
index f0539b29..9d9ee10e 100644
--- a/src/net/net.h
+++ b/src/net/net.h
@@ -23,7 +23,11 @@
#define NET_H
/**
- * \defgroup Network Core network layer
+ * \namespace Net
+ *
+ * The network communication layer. It is composed of a host of interfaces that
+ * interact with different aspects of the game. They have different
+ * implementations depending on the type of server the client is connecting to.
*/
#include "net/serverinfo.h"