Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7421 for sandbox_qt/doc/api


Ignore:
Timestamp:
Sep 12, 2010, 12:47:30 AM (14 years ago)
Author:
rgrieder
Message:

Basic stuff up and running for the Qt sandbox.
No GUI support yet.

Location:
sandbox_qt/doc/api
Files:
1 deleted
3 edited

Legend:

Unmodified
Added
Removed

  • sandbox_qt/doc/api/Groups.dox

    r7401 r7421  
    4444
    4545/**
    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 /**
    6146    @defgroup Config Config
    6247    @ingroup Core
    6348*/
    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 
    128 /**
    129     @defgroup Overlays Overlays
    130     @ingroup Modules
    131 */
    132 
    133 /**
    134     @defgroup Pickup Pickup
    135     @ingroup Modules
    136 */
    137 
    138 /**
    139     @defgroup Pong Pong
    140     @ingroup Modules
    141 */
    142 
    143 /**
    144     @defgroup Questsystem Questsystem
    145     @ingroup Modules
    146 */
    147 
    148 /**
    149     @defgroup Weapons Weapons
    150     @ingroup Modules
    151 */

  • sandbox_qt/doc/api/doxy.config.in

    r7401 r7421  
    624624# subdirectory from a directory tree whose root is specified with the INPUT tag.
    625625
    626 EXCLUDE                = @CMAKE_SOURCE_DIR@/src/external/bullet/ \
    627                          @CMAKE_SOURCE_DIR@/src/external/cpptcl/ \
    628                          @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.5.0 \
    629                          @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.6.0 \
    630                          @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.6.1 \
    631                          @CMAKE_SOURCE_DIR@/src/libraries/core/command/IOConsoleWindows.h \
    632                          @CMAKE_SOURCE_DIR@/src/libraries/core/command/IOConsoleWindows.cc \
    633                          @CMAKE_SOURCE_DIR@/src/libraries/tools/bsp \
     626EXCLUDE                =
    634627
    635628# The EXCLUDE_SYMLINKS tag can be used select whether or not files or

  • sandbox_qt/doc/api/main.dox

    r7401 r7421  
    22    @mainpage
    33
    4     @image html orxonox.jpg
    5 
    6     This is the documentation of Orxonox. It contains descriptions of our classes and functions and
    7     explains their usage with several examples and background information. Because Orxonox is so big,
    8     we can't document all of our code - sorry for that! But we do your best to document the most
    9     important parts of it, namely the @ref Core "core" and @ref Util "util" libraries, as well as the
    10     central classes in the @ref Orxonox "orxonox" main library and some @ref Modules "modules".
    11 
    12     To understand the connection between different classes in Orxonox, have a look at the
    13     <a href="modules.html"><b>Modules section</b></a>. It contains a list of the most important topics
    14     and groups files that contribute to the same feature.
     4    This is the documentation of some test project. It has not yet been written though...
    155*/
Note: See TracChangeset for help on using the changeset viewer.