| 1 | /* | 
|---|
| 2 |  *   ORXONOX - the hottest 3D action shooter ever to exist | 
|---|
| 3 |  *                    > www.orxonox.net < | 
|---|
| 4 |  * | 
|---|
| 5 |  * | 
|---|
| 6 |  *   License notice: | 
|---|
| 7 |  * | 
|---|
| 8 |  *   This program is free software; you can redistribute it and/or | 
|---|
| 9 |  *   modify it under the terms of the GNU General Public License | 
|---|
| 10 |  *   as published by the Free Software Foundation; either version 2 | 
|---|
| 11 |  *   of the License, or (at your option) any later version. | 
|---|
| 12 |  * | 
|---|
| 13 |  *   This program is distributed in the hope that it will be useful, | 
|---|
| 14 |  *   but WITHOUT ANY WARRANTY; without even the implied warranty of | 
|---|
| 15 |  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the | 
|---|
| 16 |  *   GNU General Public License for more details. | 
|---|
| 17 |  * | 
|---|
| 18 |  *   You should have received a copy of the GNU General Public License | 
|---|
| 19 |  *   along with this program; if not, write to the Free Software | 
|---|
| 20 |  *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. | 
|---|
| 21 |  * | 
|---|
| 22 |  *   Author: | 
|---|
| 23 |  *      Fabian 'x3n' Landau | 
|---|
| 24 |  *   Co-authors: | 
|---|
| 25 |  *      Damian 'Mozork' Frick | 
|---|
| 26 |  * | 
|---|
| 27 |  */ | 
|---|
| 28 |  | 
|---|
| 29 | /** | 
|---|
| 30 |     @defgroup Util Util | 
|---|
| 31 |  | 
|---|
| 32 |     The util library contains several functions, classes, and templates that can be used in different | 
|---|
| 33 |     parts of the Orxonox-code. They provide functionalities for mathematical use, string manipulation, | 
|---|
| 34 |     typeconversion, multi-types, error- and exception-handling, debug output, and many more. | 
|---|
| 35 | */ | 
|---|
| 36 |  | 
|---|
| 37 | /** | 
|---|
| 38 |     @defgroup Core Core | 
|---|
| 39 |  | 
|---|
| 40 |     The core library contains the framework of Orxonox - all important classes, functions, and macros | 
|---|
| 41 |     that are used to create and manage classes and objects. Almost all classes in Orxonox need at least | 
|---|
| 42 |     one of the core features. | 
|---|
| 43 | */ | 
|---|
| 44 |  | 
|---|
| 45 | /** | 
|---|
| 46 |     @defgroup Class Class management | 
|---|
| 47 |     @ingroup Core | 
|---|
| 48 | */ | 
|---|
| 49 |  | 
|---|
| 50 | /** | 
|---|
| 51 |     @defgroup Object Object management | 
|---|
| 52 |     @ingroup Core | 
|---|
| 53 | */ | 
|---|
| 54 |  | 
|---|
| 55 | /** | 
|---|
| 56 |     @defgroup Command Command | 
|---|
| 57 |     @ingroup Core | 
|---|
| 58 | */ | 
|---|
| 59 |  | 
|---|
| 60 | /** | 
|---|
| 61 |     @defgroup Config Config | 
|---|
| 62 |     @ingroup Core | 
|---|
| 63 | */ | 
|---|
| 64 |  | 
|---|
| 65 | /** | 
|---|
| 66 |     @defgroup Input Input | 
|---|
| 67 |     @ingroup Core | 
|---|
| 68 | */ | 
|---|
| 69 |  | 
|---|
| 70 | /** | 
|---|
| 71 |     @defgroup Management Management | 
|---|
| 72 |     @ingroup Core | 
|---|
| 73 | */ | 
|---|
| 74 |  | 
|---|
| 75 | /** | 
|---|
| 76 |     @defgroup XML XML | 
|---|
| 77 |     @ingroup Core | 
|---|
| 78 | */ | 
|---|
| 79 |  | 
|---|
| 80 | /** | 
|---|
| 81 |     @defgroup Network Network | 
|---|
| 82 |  | 
|---|
| 83 |     The network library is used to connect clients and server, to synchronize objects and variables, and | 
|---|
| 84 |     to transmit network function calls. It contains the central @ref orxonox::Server "Server" and | 
|---|
| 85 |     @ref orxonox::Client "Client" classes as well as several functions and macros for | 
|---|
| 86 |     @ref orxonox::Synchronisable "synchronisable" classes. | 
|---|
| 87 | */ | 
|---|
| 88 |  | 
|---|
| 89 | /** | 
|---|
| 90 |     @defgroup Tools Tools | 
|---|
| 91 |  | 
|---|
| 92 |     The tools are a bunch of utilities that belong to the Orxonox library, but are independent of other | 
|---|
| 93 |     features. | 
|---|
| 94 | */ | 
|---|
| 95 |  | 
|---|
| 96 | /** | 
|---|
| 97 |     @defgroup Orxonox Orxonox | 
|---|
| 98 |  | 
|---|
| 99 |     The Orxonox library contains the central and most important classes of the game. Managers, interfaces, | 
|---|
| 100 |     base-classes, and more are located in Orxonox. More specialized classes that inherit of the base-classes | 
|---|
| 101 |     in Orxonox are often sourced out to the modules. | 
|---|
| 102 | */ | 
|---|
| 103 |  | 
|---|
| 104 | /** | 
|---|
| 105 |     @defgroup Modules Modules | 
|---|
| 106 |  | 
|---|
| 107 |     The modules are libraries that depend on the Orxonox library and that are loaded dynamically on runtime | 
|---|
| 108 |     (in contrast to statically loaded libraries like util and core). Each module contains some classes that | 
|---|
| 109 |     are usually connected to each other, but they are independent of other modules. However modules can still | 
|---|
| 110 |     link to other modules, but only in a hierarchical order, no circular dependencies. | 
|---|
| 111 | */ | 
|---|
| 112 |  | 
|---|
| 113 | /** | 
|---|
| 114 |     @defgroup Designtools Designtools | 
|---|
| 115 |     @ingroup Modules | 
|---|
| 116 | */ | 
|---|
| 117 |  | 
|---|
| 118 | /** | 
|---|
| 119 |     @defgroup Notifications Notifications | 
|---|
| 120 |     @ingroup Modules | 
|---|
| 121 | */ | 
|---|
| 122 |  | 
|---|
| 123 | /** | 
|---|
| 124 |     @defgroup Objects Objects | 
|---|
| 125 |     @ingroup Modules | 
|---|
| 126 |  | 
|---|
| 127 |     @defgroup Collisionshapes Collisionshapes | 
|---|
| 128 |     @ingroup Objects | 
|---|
| 129 |  | 
|---|
| 130 |     @defgroup Eventsystem Eventsystem | 
|---|
| 131 |     @ingroup Objects | 
|---|
| 132 |  | 
|---|
| 133 |     @defgroup Triggers Triggers | 
|---|
| 134 |     @ingroup Objects | 
|---|
| 135 | */ | 
|---|
| 136 |  | 
|---|
| 137 | /** | 
|---|
| 138 |     @defgroup Overlays Overlays | 
|---|
| 139 |     @ingroup Modules | 
|---|
| 140 | */ | 
|---|
| 141 |  | 
|---|
| 142 | /** | 
|---|
| 143 |     @defgroup Pickup Pickup | 
|---|
| 144 |     @ingroup Modules | 
|---|
| 145 | */ | 
|---|
| 146 |  | 
|---|
| 147 | /** | 
|---|
| 148 |     @defgroup Pong Pong | 
|---|
| 149 |     @ingroup Modules | 
|---|
| 150 |  | 
|---|
| 151 |     Pong is a minigame. | 
|---|
| 152 | */ | 
|---|
| 153 |  | 
|---|
| 154 | /** | 
|---|
| 155 |     @defgroup Portals Portals | 
|---|
| 156 |     @ingroup Modules | 
|---|
| 157 | */ | 
|---|
| 158 |  | 
|---|
| 159 | /** | 
|---|
| 160 |     @defgroup Questsystem Questsystem | 
|---|
| 161 |     @ingroup Modules | 
|---|
| 162 | */ | 
|---|
| 163 |  | 
|---|
| 164 | /** | 
|---|
| 165 |     @defgroup Weapons Weapons | 
|---|
| 166 |     @ingroup Modules | 
|---|
| 167 | */ | 
|---|