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. --- ChangeLog | 10 ++++- INSTALL | 2 +- NEWS | 2 +- docs/SOURCE/tmw.doxcfg | 2 +- docs/SOURCE/tmwdox.sh | 0 src/gui/char_select.h | 2 +- src/main.h | 29 ++++++++++++ src/net/connection.h | 3 ++ src/net/messagehandler.h | 3 ++ src/net/messagein.h | 2 + src/net/messageout.h | 5 ++- src/net/network.h | 7 +++ src/resources/equipmentdb.h | 107 +++++++++++++++++++++++--------------------- src/resources/itemdb.h | 2 +- src/resources/monsterdb.h | 93 +++++++++++++++++++------------------- src/utils/xml.h | 3 ++ 16 files changed, 168 insertions(+), 104 deletions(-) mode change 100644 => 100755 docs/SOURCE/tmwdox.sh diff --git a/ChangeLog b/ChangeLog index 44caf16c..1ff45551 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,4 +1,12 @@ -2007-01-23 Bjørn Lindeijer +2007-01-28 Bjørn Lindeijer + + * src/gui/char_select.h, src/net/messagein.h, + src/net/messagehandler.h, src/net/network.h, src/net/connection.h, + src/net/messageout.h, src/utils/xml.h, src/main.h, + src/resources/monsterdb.h, src/resources/itemdb.h, + src/resources/equipmentdb.h: Some work on documentation. + +2007-01-23 Bjørn Lindeijer * src/gui/shoplistbox.cpp, docs/INSTALL/win32.txt, INSTALL, NEWS: Upgraded to Guichan 0.6.1. diff --git a/INSTALL b/INSTALL index f7e8688e..0f5d53f0 100644 --- a/INSTALL +++ b/INSTALL @@ -20,7 +20,7 @@ and some libraries. The required libraries are: * SDL_mixer http://www.libsdl.org/projects/SDL_mixer/ * SDL_image http://www.libsdl.org/projects/SDL_image/ * SDL_net http://www.libsdl.org/projects/SDL_net/ -* Guichan 0.6.1 http://guichan.sourceforge.net/ +* Guichan 0.6.x http://guichan.sourceforge.net/ * libxml2 http://www.xmlsoft.org/ * physfs 1.0.x http://icculus.org/physfs/ * zlib 1.2.x http://www.gzip.org/zlib/ diff --git a/NEWS b/NEWS index 47421aef..adeca670 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,5 @@ 0.0.22.2 (...) -- Updated to work with Guichan 0.6.1 (older versions no longer supported) +- Updated to work with Guichan 0.6.1 0.0.22.1 (15 January 2007) - Updated to work with Guichan 0.6.0 (older versions no longer supported) diff --git a/docs/SOURCE/tmw.doxcfg b/docs/SOURCE/tmw.doxcfg index fe5039fb..19cfb024 100644 --- a/docs/SOURCE/tmw.doxcfg +++ b/docs/SOURCE/tmw.doxcfg @@ -1085,7 +1085,7 @@ CALL_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. -GRAPHICAL_HIERARCHY = YES +GRAPHICAL_HIERARCHY = NO # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif diff --git a/docs/SOURCE/tmwdox.sh b/docs/SOURCE/tmwdox.sh old mode 100644 new mode 100755 diff --git a/src/gui/char_select.h b/src/gui/char_select.h index d6dee8b5..dbce2cbf 100644 --- a/src/gui/char_select.h +++ b/src/gui/char_select.h @@ -94,7 +94,7 @@ class CharSelectDialog : public Window, public gcn::ActionListener /** * Character creation dialog. * - * \ingroup GUI + * \ingroup Interface */ class CharCreateDialog : public Window, public gcn::ActionListener { 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 diff --git a/src/net/connection.h b/src/net/connection.h index d8ea3124..734c8d65 100644 --- a/src/net/connection.h +++ b/src/net/connection.h @@ -32,6 +32,9 @@ class MessageOut; namespace Net { + /** + * \ingroup Network + */ class Connection { public: diff --git a/src/net/messagehandler.h b/src/net/messagehandler.h index b21abd72..a5fc81b3 100644 --- a/src/net/messagehandler.h +++ b/src/net/messagehandler.h @@ -28,6 +28,9 @@ class MessageIn; +/** + * \ingroup Network + */ class MessageHandler { public: diff --git a/src/net/messagein.h b/src/net/messagein.h index 68bbb933..cb8e44cd 100644 --- a/src/net/messagein.h +++ b/src/net/messagein.h @@ -30,6 +30,8 @@ /** * Used for parsing an incoming message. + * + * \ingroup Network */ class MessageIn { diff --git a/src/net/messageout.h b/src/net/messageout.h index af25e4b4..82412a30 100644 --- a/src/net/messageout.h +++ b/src/net/messageout.h @@ -27,7 +27,10 @@ #include /** - * Used for building an outgoing message. + * Used for building an outgoing message. When finished, the message is sent + * using Net::Connection::send(). + * + * \ingroup Network */ class MessageOut { diff --git a/src/net/network.h b/src/net/network.h index 9ffcbb6d..0701a956 100644 --- a/src/net/network.h +++ b/src/net/network.h @@ -26,9 +26,16 @@ #include +/** + * \defgroup Network Core network layer + */ + class MessageHandler; class MessageOut; +/** + * \ingroup Network + */ namespace Net { class Connection; diff --git a/src/resources/equipmentdb.h b/src/resources/equipmentdb.h index b8618f5f..b43a6145 100644 --- a/src/resources/equipmentdb.h +++ b/src/resources/equipmentdb.h @@ -1,52 +1,55 @@ -/* - * The Mana World - * Copyright 2006 The Mana World Development Team - * - * This file is part of The Mana World. - * - * The Mana World 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 - * any later version. - * - * The Mana World is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with The Mana World; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - * - * $Id: - */ - -#ifndef _TMW_EQUIPMENT_DB_H -#define _TMW_EQUIPMENT_DB_H - -#include - -#include "equipmentinfo.h" - -namespace EquipmentDB -{ - /** - * Loads the equipment info from Items.xml - */ - void load(); - - /** - * Frees equipment data - */ - void unload(); - - void setEquipment(int id, EquipmentInfo* equipmentInfo); - - EquipmentInfo* get(int id); - - // Equipment database types - typedef std::map EquipmentInfos; - typedef EquipmentInfos::iterator EquipmentInfoIterator; -} - -#endif +/* + * The Mana World + * Copyright 2006 The Mana World Development Team + * + * This file is part of The Mana World. + * + * The Mana World 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 + * any later version. + * + * The Mana World is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with The Mana World; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * $Id: + */ + +#ifndef _TMW_EQUIPMENT_DB_H +#define _TMW_EQUIPMENT_DB_H + +#include + +#include "equipmentinfo.h" + +/** + * Equipment information database. + */ +namespace EquipmentDB +{ + /** + * Loads the equipment info from Items.xml + */ + void load(); + + /** + * Frees equipment data + */ + void unload(); + + void setEquipment(int id, EquipmentInfo* equipmentInfo); + + EquipmentInfo* get(int id); + + // Equipment database types + typedef std::map EquipmentInfos; + typedef EquipmentInfos::iterator EquipmentInfoIterator; +} + +#endif diff --git a/src/resources/itemdb.h b/src/resources/itemdb.h index c080194b..6ead5b22 100644 --- a/src/resources/itemdb.h +++ b/src/resources/itemdb.h @@ -29,7 +29,7 @@ #include /** - * The namespace that holds the item information. + * Item information database. */ namespace ItemDB { diff --git a/src/resources/monsterdb.h b/src/resources/monsterdb.h index b105665a..3b69523d 100644 --- a/src/resources/monsterdb.h +++ b/src/resources/monsterdb.h @@ -1,45 +1,48 @@ -/* - * The Mana World - * Copyright 2004 The Mana World Development Team - * - * This file is part of The Mana World. - * - * The Mana World 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 - * any later version. - * - * The Mana World is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with The Mana World; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - * - * $Id: - */ - -#ifndef _TMW_MONSTER_DB_H -#define _TMW_MONSTER_DB_H - -#include - -#include "monsterinfo.h" - -namespace MonsterDB -{ - void - load(); - - void - unload(); - - const MonsterInfo& get (int id); - - typedef std::map MonsterInfos; - typedef MonsterInfos::iterator MonsterInfoIterator; -} - -#endif +/* + * The Mana World + * Copyright 2004 The Mana World Development Team + * + * This file is part of The Mana World. + * + * The Mana World 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 + * any later version. + * + * The Mana World is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with The Mana World; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * $Id: + */ + +#ifndef _TMW_MONSTER_DB_H +#define _TMW_MONSTER_DB_H + +#include + +#include "monsterinfo.h" + +/** + * Monster information database. + */ +namespace MonsterDB +{ + void + load(); + + void + unload(); + + const MonsterInfo& get (int id); + + typedef std::map MonsterInfos; + typedef MonsterInfos::iterator MonsterInfoIterator; +} + +#endif diff --git a/src/utils/xml.h b/src/utils/xml.h index 54ed9951..bf01fc96 100644 --- a/src/utils/xml.h +++ b/src/utils/xml.h @@ -28,6 +28,9 @@ #include +/** + * XML helper functions. + */ namespace XML { /** -- cgit v1.2.3-70-g09d2