home *** CD-ROM | disk | FTP | other *** search
/ Enter 2005 October / enter-2005-10.iso / files / el_112_install.exe / groups.doxy < prev    next >
Encoding:
Text File  |  2005-05-04  |  12.6 KB  |  482 lines
  1. /* This file is only used for creating groups for Doxygen */
  2.  
  3. ///////////////////////////////////////////////////////////////////////////////
  4. //                       The initialization phase                      //
  5. ///////////////////////////////////////////////////////////////////////////////
  6. /*!
  7.  * \defgroup     init Initialization
  8.  *         The initialization phase - loading of variables, parsing files etc.
  9.  */
  10. /*!
  11.  * \defgroup    config Configuration
  12.  *        The functions used for parsing the configuration files
  13.  * \ingroup    init
  14.  */
  15. /*!
  16.  * \defgroup    encyclopedia Encyclopedia
  17.  *        The functions used for loading the Encyclopedia
  18.  * \ingroup    init
  19.  */
  20. /*!
  21.  * \defgroup    translation Translation
  22.  *        The functions used in EL's implementation of multiple languages support
  23.  * \ingroup    init
  24.  */
  25. /*!
  26.  * \defgroup    loadsave Loading/Saving settings
  27.  *        About the el.cfg file that has the saved settings.
  28.  * \ingroup    init
  29.  */
  30. /*!
  31.  * \defgroup    video Video initialization
  32.  *        About the video/GL initialization phase.
  33.  * \ingroup    init
  34.  */
  35. /*!
  36.  * \defgroup    hotkey Hotkeys
  37.  *        On how hotkeys are loaded and defined.
  38.  * \ingroup    init
  39.  */
  40. /*!
  41.  * \defgroup    other Other
  42.  *         Various functions/files used for the init phase.
  43.  * \ingroup    init
  44.  */
  45.  
  46.  
  47. ///////////////////////////////////////////////////////////////////////////////
  48. //              Loading files and file formats                 //
  49. ///////////////////////////////////////////////////////////////////////////////
  50. /*!
  51.  * \defgroup     load Loading files
  52.  *         About loading files and the file formats in the EL
  53.  */
  54. /*!
  55.  * \defgroup    cache The cache system
  56.  *         About the cache system used in EL
  57.  * \ingroup    load
  58.  */
  59. /*!\defgroup    load_bmp    Load texture bitmaps
  60.         Covers Eternal Lands texture loading
  61.  *  \ingroup    load
  62.  */
  63. /*!
  64.  * \defgroup     load_2d Load 2D Objects
  65.  *         Functions used in loading 2D objects
  66.  * \ingroup     load
  67.  */
  68. /*!
  69.  * \defgroup     load_3d Load 3D Objects
  70.  *         Functions used when loading 3D objects
  71.  * \ingroup     load
  72.  */
  73. /*!
  74.  * \defgroup    actors_load Loading actors and MD2s
  75.  *        Functions used when loading actors and MD2s
  76.  * \ingroup    load
  77.  */
  78. /*!
  79.  * \defgroup    maps Loading maps
  80.  *         About loading the elm-maps and the map format.
  81.  * \ingroup    load
  82.  */
  83. /*!
  84.  * \defgroup    particles Particles
  85.  *         About loading particles and the .part-format
  86.  * \ingroup    load
  87.  */
  88.  
  89.  
  90. ///////////////////////////////////////////////////////////////////////////////
  91. //                      Rendering groups                 // 
  92. ///////////////////////////////////////////////////////////////////////////////
  93. /*!
  94.  * \defgroup     display Rendering
  95.  *         The group contains the functions used in the rendering phase
  96.  */
  97. /*!
  98.  * \defgroup     display_2d Display 2D Objects
  99.  *         Functions used in displaying 2D objects
  100.  * \ingroup     display
  101.  */
  102. /*!
  103.  * \defgroup     display_3d Display 3D Objects
  104.  *         Functions used in displaying 3D objects
  105.  * \ingroup     display
  106.  */
  107. /*!
  108.  * \defgroup     display_actors Display actors
  109.  *         Functions used in displaying actors
  110.  * \ingroup     display
  111.  */
  112. /*!
  113.  * \defgroup    lights Lights
  114.  *        Displaying lights in EL
  115.  * \ingroup    display
  116.  */
  117. /*!
  118.  * \defgroup    shadows Shadows
  119.  *        On shadows and effects
  120.  * \ingroup    display
  121.  */
  122. /*!
  123.  * \defgroup    reflections Reflections
  124.  *        About reflections in EL
  125.  * \ingroup    display
  126.  */
  127. /*!
  128.  * \defgroup    tile The tiles
  129.  *        Handles displaying tiles and adding tile effects
  130.  * \ingroup    display
  131.  */
  132. /*!
  133.  * \defgroup    display_weather Wheater Effects
  134.  *         Handles the weather effects in EL
  135.  * \ingroup    display
  136.  */
  137. /*!
  138.  * \defgroup    text_font Text and fonts
  139.  *        Covers the basics of the EL text and font implementation
  140.  * \ingroup    display
  141.  */
  142. /*!
  143.  * \defgroup    display_utils Utilities and misc.
  144.  *         About the more basic functions useful when displaying
  145.  * \ingroup    display
  146.  */
  147.  
  148.  
  149. ///////////////////////////////////////////////////////////////////////////////
  150. //                     Networking/protocol groups                 //
  151. ///////////////////////////////////////////////////////////////////////////////
  152. /*!
  153.  * \defgroup    network Network
  154.  *         The group contains information about the EL protocol and the network implementation in EL
  155.  */
  156. /*!
  157.  * \defgroup    protocol Generic protocol information
  158.  *        Some general info about the protocol
  159.  * \ingroup    network
  160.  */
  161. /*!
  162.  * \defgroup    login Login and new characters
  163.  *        About the login-phase and the new characters
  164.  * \ingroup    network
  165.  */
  166. /*!
  167.  * \defgroup    network_text Text and dialogues
  168.  *        About text and dialogues in EL
  169.  * \ingroup    network
  170.  */
  171. /*!
  172.  * \defgroup    trade Trading
  173.  *         About the network handling of trading.
  174.  * \ingroup    network
  175.  */
  176. /*!
  177.  * \defgroup    item Item handling
  178.  *        About the item handling
  179.  * \ingroup    network
  180.  */
  181. /*!
  182.  * \defgroup    network_actors Actors and network data
  183.  *         Functions used for actor-related network data
  184.  * \ingroup    network
  185.  */
  186. /*!
  187.  * \defgroup    network_trade Handling trade sessions
  188.  *         About the network-side trade sessions in EL
  189.  * \ingroup    network
  190.  */
  191. /*!
  192.  * \defgroup    network_magic Spells and magic
  193.  *         About the network-side implementation of spells and magic
  194.  * \ingroup    network
  195.  */
  196. /*!
  197.  * \defgroup    updates Web-updates (http retrieval)
  198.  *         About the http implementation in EL, allowing updates to happen from within the client
  199.  * \ingroup    network
  200.  */
  201. /*!
  202.  * \defgroup    network_misc Miscellaneous
  203.  *         Miscellaneous functions - i.e. used for updating the weather
  204.  * \ingroup    network
  205.  */
  206.  
  207.  
  208. ///////////////////////////////////////////////////////////////////////////////
  209. //                     Event handling and the WM                 //
  210. ///////////////////////////////////////////////////////////////////////////////
  211. /*!
  212.  * \defgroup    events Events and the Window manager
  213.  *         The group contains information about the event handling and the Window manager
  214.  */
  215. /*!
  216.  * \defgroup    event_handle Main event handling
  217.  *         Covers the main event handling
  218.  * \ingroup    events
  219.  */
  220. /*!
  221.  * \defgroup    events_actors Actor events
  222.  *         Actor events
  223.  * \ingroup    events
  224.  */
  225. /*!
  226.  * \defgroup    elwindows The EL Window Manager
  227.  *        About the EL window manager and it's uses
  228.  * \ingroup    events
  229.  */
  230. /*!
  231.  * \defgroup    widgets Widgets
  232.  *        Covers widgets for the WM
  233.  * \ingroup    elwindows
  234.  */
  235. /*!
  236.  * \defgroup    xml_windows XML Defined Windows
  237.  *         Eternal Lands supports XML defined windows through widgets
  238.  * \ingroup    elwindows
  239.  */
  240.  
  241. ///////////////////////////////////////////////////////////////////////////////
  242. //                            Windows in EL                    //
  243. ///////////////////////////////////////////////////////////////////////////////
  244. /*!
  245.  * \defgroup    windows Windows
  246.  *         The main group for all of the different windows
  247.  * \ingroup    elwindows
  248.  */
  249. /*!
  250.  * \defgroup    root_window The root window of the client
  251.  *      Displays the root window the client. The root window handles all the other possible windows as its client windows.
  252.  * \ingroup windows
  253.  */
  254. /*!
  255.  * \defgroup    books_window Displaying books
  256.  *         About displaying the book windows
  257.  * \ingroup    windows
  258.  */
  259. /*!
  260.  * \defgroup    buddy_window The buddy window
  261.  *         About the buddy window
  262.  * \ingroup    windows
  263.  */
  264. /*!
  265.  * \defgroup    encyclopedia_window The Encyclopedia window
  266.  *         The Encyclopedia window
  267.  * \ingroup    windows
  268.  */
  269. /*!
  270.  * \defgroup    knowledge_window The knowledge window
  271.  *         The knowledge window displays the characters current knowledges
  272.  * \ingroup    windows
  273.  */
  274. /*!
  275.  * \defgroup    items_window The inventory window
  276.  *        The inventory window shows your inventory items + what you are currently wearing.
  277.  * \ingroup    windows
  278.  */
  279. /*!
  280.  * \defgroup    manufacture_window The manufacture window
  281.  *        About displaying the manufacture window
  282.  * \ingroup    windows
  283.  */
  284. /*!
  285.  * \defgroup    options_window Options
  286.  *        Shows the game options
  287.  * \ingroup    windows
  288.  */
  289. /*!
  290.  * \defgroup    quest_window The Questlog
  291.  *         Shows the questlog window
  292.  * \ingroup    windows
  293.  */
  294. /*!
  295.  * \defgroup    rules_window The rules window
  296.  *         About the rules window (see also the rules interface)
  297.  * \ingroup    windows
  298.  */
  299. /*!
  300.  * \defgroup    spells_window The spell window
  301.  *         The spell window displays sigils and the current spell combination
  302.  * \ingroup    windows
  303.  */
  304. /*!
  305.  * \defgroup    stats_window The statistics window
  306.  *         The statistics window shows your characters current levels
  307.  * \ingroup    windows
  308.  */
  309. /*!
  310.  * \defgroup    trade_window The trade window
  311.  *         Shows the trade window
  312.  * \ingroup    windows
  313.  */
  314. /*!
  315.  * \defgroup    help_window The help window
  316.  *      Shows the help window
  317.  * \ingroup windows
  318.  */
  319. /*!
  320.  * \defgroup    chat_window    The new chat window
  321.  *      Shows the chat window
  322.  * \ingroup windows
  323.  */
  324. /*!
  325.  * \defgroup    notepad_window The new in-game notepad
  326.  *      Handles the in-game notepad
  327.  * \ingroup windows
  328.  */
  329. /*!
  330.  * \defgroup    storage_window The new storage interface
  331.  *      Handles the new storage interface
  332.  * \ingroup windows
  333.  */
  334.  
  335. ///////////////////////////////////////////////////////////////////////////////
  336. //              Interfaces (root windows) in EL                 //
  337. ///////////////////////////////////////////////////////////////////////////////
  338. /*!
  339.  * \defgroup     interfaces Interfaces (root windows)
  340.  *        Covers the EL interfaces (root windows)
  341.  * \ingroup    elwindows
  342.  */
  343. /*!
  344.  * \defgroup    interface_opening Opening interface
  345.  *         The opening interface
  346.  * \ingroup    interfaces
  347.  */
  348. /*!
  349.  * \defgroup    interface_login Login interface
  350.  *        The login interface
  351.  * \ingroup    interfaces
  352.  */
  353. /*!
  354.  * \defgroup    interface_newchar Character creation screen
  355.  *         The character creation screen.
  356.  * \ingroup    interfaces
  357.  */
  358. /*!
  359.  * \defgroup    interface_console The console
  360.  *        The console interface
  361.  * \ingroup    interfaces
  362.  */
  363. /*!
  364.  * \defgroup    interface_map The map and continent view
  365.  *         The map and continent view
  366.  * \ingroup    interfaces
  367.  */
  368. /*!
  369.  * \defgroup    interface_rules The rules interface
  370.  *        Covers displaying the rules
  371.  * \ingroup    interfaces
  372.  */
  373.  
  374. ///////////////////////////////////////////////////////////////////////////////
  375. //                  Widgets and XML-defined windows                    //
  376. ///////////////////////////////////////////////////////////////////////////////
  377. /*!
  378.  * \defgroup    labels Labels
  379.  *         A label widget
  380.  * \ingroup    widgets
  381.  */
  382. /*!
  383.  * \defgroup    images Images
  384.  *         An image widge
  385.  * \ingroup    widgets
  386.  */
  387. /*!
  388.  * \defgroup    checkboxes Checkboxes
  389.  *         A checkbox widget
  390.  * \ingroup    widgets
  391.  */
  392. /*!
  393.  * \defgroup    buttons Buttons
  394.  *         A button widget
  395.  * \ingroup    widgets
  396.  */
  397. /*!
  398.  * \defgroup    progressbars Progressbars
  399.  *         A widget for a progressbar
  400.  * \ingroup    widgets
  401.  */
  402. /*!
  403.  * \defgroup    scrollbars Scrollbars
  404.  *         A scrollbar widget
  405.  * \ingroup    widgets
  406.  */
  407. /*!
  408.  * \defgroup    tabs    Tabwindows
  409.  *      A tabbed window widget
  410.  * \ingroup widgets
  411.  */
  412.  
  413. ///////////////////////////////////////////////////////////////////////////////
  414. //                           Sound and music                 //
  415. ///////////////////////////////////////////////////////////////////////////////
  416. /*!
  417.  * \defgroup    sound Sound and music
  418.  *         Covers the sound and music implementation in EL (using OpenAL)
  419.  */
  420. /*!
  421.  * \defgroup    sound_effects Sound effects
  422.  *         Adding sound effects to EL
  423.  * \ingroup    sound
  424.  */
  425. /*!
  426.  * \defgroup     music Music playback
  427.  *         The client handles playback of Ogg Vorbis files
  428.  * \ingroup    sound
  429.  */
  430.  
  431. ///////////////////////////////////////////////////////////////////////////////
  432. //                         Threading and EL                          //
  433. ///////////////////////////////////////////////////////////////////////////////
  434. /*!
  435.  * \defgroup    thread Threading
  436.  *        The group contains information about threading in the EL client
  437.  */
  438. /*!
  439.  * \defgroup     move_actors Actors movement/animations
  440.  *         Functions used for implementing the actors movement/animations
  441.  * \ingroup    thread
  442.  */
  443. /*!
  444.  * \defgroup     mutex Mutexes
  445.  *         The mutexes used in EL
  446.  * \ingroup    thread
  447.  */
  448. /*!
  449.  * \defgroup    timers Timers
  450.  *         The timers in EL
  451.  * \ingroup    thread
  452.  */
  453.  
  454.  
  455. ///////////////////////////////////////////////////////////////////////////////
  456. //                     Miscellaneous groups                          //
  457. ///////////////////////////////////////////////////////////////////////////////
  458. /*!
  459.  * \defgroup     misc Miscellaneous
  460.  *         The group contains miscellaneous functions/utilities and files
  461.  */
  462. /*!
  463.  * \defgroup    actors_utils Actor utilities
  464.  *         Miscellaneous functions for actors
  465.  * \ingroup    misc
  466.  */
  467. /*!
  468.  * \defgroup     misc_utils Miscellaneous Utilities
  469.  *         Miscellaneous functions that are useful when you're working with the client
  470.  * \ingroup    misc
  471.  */
  472. /*!
  473.  * \defgroup    commands Console commands
  474.  *         Covers the console command handling
  475.  * \ingroup    misc
  476.  */
  477. /*!
  478.  * \defgroup    xml_utils XML Utilities
  479.  *        Miscellaneous common functions used in the clients XML-handling
  480.  * \ingroup    misc
  481.  */
  482.