Some work on documentation.

3 files changed, 104 insertions, 98 deletions

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 <map>

-

-#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<int, EquipmentInfo*> 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 <map>
+
+#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<int, EquipmentInfo*> 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 <map>

 

 /**

- * 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 <map>

-

-#include "monsterinfo.h"

-

-namespace MonsterDB

-{

-    void

-    load();

-

-    void

-    unload();

-

-    const MonsterInfo& get (int id);

-

-    typedef std::map<int, MonsterInfo*> 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 <map>
+
+#include "monsterinfo.h"
+
+/**
+ * Monster information database.
+ */
+namespace MonsterDB
+{
+    void
+    load();
+
+    void
+    unload();
+
+    const MonsterInfo& get (int id);
+
+    typedef std::map<int, MonsterInfo*> MonsterInfos;
+    typedef MonsterInfos::iterator MonsterInfoIterator;
+}
+
+#endif