Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/doc/api/Groups.dox @ 7357

Last change on this file since 7357 was 7357, checked in by rgrieder, 14 years ago

Changed command line arguments reference to a simple Doxygen page containing the usage information text.

  • Property svn:eol-style set to native
File size: 3.8 KB
Line 
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 *      ...
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 CmdArgs Commandline Arguments
62    @ingroup Command
63    @brief For a reference see @ref cmdargspage
64*/
65
66/**
67    @defgroup Config Config
68    @ingroup Core
69*/
70
71/**
72    @defgroup Events Events
73    @ingroup Core
74*/
75
76/**
77    @defgroup Input Input
78    @ingroup Core
79*/
80
81/**
82    @defgroup Output Output
83    @ingroup Core
84*/
85
86/**
87    @defgroup XML XML
88    @ingroup Core
89*/
90
91/**
92    @defgroup Network Network
93
94    The network library is used to connect clients and server, to synchronize objects and variables, and
95    to transmit network function calls. It contains the central @ref orxonox::Server "Server" and
96    @ref orxonox::Client "Client" classes as well as several functions and macros for
97    @ref orxonox::Synchronisable "synchronisable" classes.
98*/
99
100/**
101    @defgroup Tools Tools
102
103    The tools are a bunch of utilities that belong to the Orxonox library, but are independent of other
104    features.
105*/
106
107/**
108    @defgroup Orxonox Orxonox
109
110    The Orxonox library contains the central and most important classes of the game. Managers, interfaces,
111    base-classes, and more are located in Orxonox. More specialized classes that inherit of the base-classes
112    in Orxonox are often sourced out to the modules.
113*/
114
115/**
116    @defgroup Modules Modules
117
118    The modules are libraries that depend on the Orxonox library and that are loaded dynamically on runtime
119    (in contrast to statically loaded libraries like util and core). Each module contains some classes that
120    are usually connected to each other, but they are independent of other modules. However modules can still
121    link to other modules, but only in a hierarchical order, no circular dependencies.
122*/
123
124/**
125    @defgroup Designtools Designtools
126    @ingroup Modules
127*/
128
129/**
130    @defgroup Notifications Notifications
131    @ingroup Modules
132*/
133
134/**
135    @defgroup Objects Objects
136    @ingroup Modules
137*/
138
139/**
140    @defgroup Overlays Overlays
141    @ingroup Modules
142*/
143
144/**
145    @defgroup Pickup Pickup
146    @ingroup Modules
147*/
148
149/**
150    @defgroup Pong Pong
151    @ingroup Modules
152*/
153
154/**
155    @defgroup Questsystem Questsystem
156    @ingroup Modules
157*/
158
159/**
160    @defgroup Weapons Weapons
161    @ingroup Modules
162*/
Note: See TracBrowser for help on using the repository browser.