Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/doc/api/Groups.h @ 7318

Last change on this file since 7318 was 7318, checked in by landauf, 14 years ago

added a draft for the group hierarchy

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