code.vuplus.com Git - vuplus_xbmc/blob - xbmc/doxygen.hpp

   1 // Mainpage layout
   2 /*!
   3         \mainpage Developer documentation for XBMC
   4         \section intro Introduction
   5         Introduction to the manual
   6
   7         \section requirements  Requirements
   8         You'll need the following to build XBMC \n
   9         - Visual Studio.NET 2003
  10         - XDK 5778 or higher
  11         - XBMC sources offcourse \n
  12           You can download the latest snapshot of XBMC here: \n
  13           http://xbmc.sourceforge.net/xbmc.tar.gz  or \n
  14           use CVS to get the sources. Look here: http://sourceforge.net/cvs/?group_id=87054 \n
  15
  16         Next
  17           - Install Visual Studio.NET \n
  18               When installing VS.NET. Make sure to install all C++ stuff
  19           - Install XDK 5778 (or higher) \n
  20               Make sure to do a full install of the XDK!!! Minimal or customized install wont work
  21           - use winrar or a similar program to uncompress xbmc.tar.gz into a folder \n
  22
  23         \section compile Compiling
  24         -# Start Visual Studio.NET and open the xbmc.sln solution file
  25         -# Next build the solution with Build->Build Solution (Ctrl+Shift+B) \n
  26         NOTE:  Dont worry about the following warnings which appear at the end of the build. \n
  27         They are normal and can be ignored \n
  28           Creating Xbox Image... \n
  29           IMAGEBLD : warning IM1029: library XONLINE is unapproved\n
  30           IMAGEBLD : warning IM1030: this image may not be accepted for certification \n
  31           Copying files to the Xbox... \n
  32         -# Then when all is build, its time to install XBMC on your xbox! \n
  33         (You can also use the build.bat file to make a build of xbmc) \n
  34
  35         \section install Installation
  36         -# edit xboxmediacenter.xml and fill in all the details for your installation \n
  37         After editting xboxmediacenter.xml you need to copy the following files & folder to your xbox \n
  38         lets say you're installing XBMC on your xbox in the folder e:\\apps\\xbmc then: \n
  39         -# create e:\\apps\\xbmc on your xbox \n
  40         -# copy following files from pc->xbox \n
  41
  42            PC                       XBOX \n
  43         -------------------------------------------------------------------------------  \n
  44         XboxMediaCenter.xml ->  e:\\apps\\xbmc\\XboxMediaCenter.xml \n
  45         keymap.xml          ->  e:\\apps\\xbmc\\keymap.xml \n
  46         FileZilla Server.xml->  e:\\apps\\xbmc\\FileZilla Server.xml \n
  47         release/default.xbe ->  e:\\apps\\xbmc\\default.xbe \n
  48         mplayer/            ->  e:\\apps\\xbmc\\mplayer        (copy all files & subdirs) \n
  49         skin/               ->  e:\\apps\\xbmc\\skin           (copy all files & subdirs) \n
  50         language/           ->  e:\\apps\\xbmc\\language       (copy all files & subdirs) \n
  51         weather/            ->  e:\\apps\\xbmc\\weather        (copy all files & subdirs) \n
  52         xbmc/keyboard/media ->  e:\\apps\\xbmc\\media          (copy all files & subdirs) \n
  53         visualisations      ->  e:\\apps\\xbmc\\visualisations (copy all files & subdirs) \n
  54         scripts/            ->  e:\\apps\\xbmc\\scripts        (these are just samples, only extract if you want to experiment with it) \n
  55         python              ->  e:\\apps\\xbmc\\python         (unpack the .rar file) \n
  56         web                 -> e:\\apps\\xbmc\\web             (unpack the .rar file) \n
  57
  58         !!! please not that you unpack the .rar files in scripts/ python/ and web/ !!! \n
  59
  60         \section links Links
  61         Related links
  62         XBMC - http://xbmc.org \n
  63         XBMC Forum - http://forum.xbmc.org/index.php \n
  64   */
  65
  66
  67 ///////////////////////////////////////
  68 //
  69 // xbmc project
  70 //
  71 ///////////////////////////////////////
  72
  73 /*!
  74         \defgroup windows XBMC windows
  75
  76         XBMC windows
  77 */
  78
  79 /*!
  80         \defgroup music Music info
  81
  82         Elements used in my music
  83 */
  84
  85
  86 //////////////////////////////////////
  87 //
  88 // guilib project
  89 //
  90 //////////////////////////////////////
  91
  92 /*!
  93         \defgroup guilib guilib classes
  94
  95         guilib classes
  96 */
  97
  98 /*!
  99         \defgroup winref Window Reference
 100         \ingroup guilib
 101
 102         The window reference
 103 */
 104
 105 /*!
 106         \defgroup winmsg Windows and Messages
 107         \ingroup winref
 108         Windows and messages
 109 */
 110
 111 /*!
 112         \defgroup controls Controls
 113         \ingroup winref
 114         Control classes
 115 */
 116
 117 /*!
 118         \defgroup winman Window Manager and Callbacks
 119         \ingroup winref
 120
 121         Everything about window manager and callbacks
 122 */
 123
 124 /*!
 125         \defgroup actionkeys Actions and Keys
 126         \ingroup winref
 127
 128         Everything around action mapping and key processing
 129 */
 130
 131 /*!
 132         \defgroup graphics Graphics and Screen
 133         \ingroup guilib
 134
 135         Everything around graphics and Screen
 136 */
 137
 138 /*!
 139         \defgroup textures Textures and Fonts
 140         \ingroup graphics
 141
 142         Everything about textures and fonts
 143 */
 144
 145 /*!
 146         \defgroup strings Strings and Localization
 147         \ingroup guilib
 148
 149         Everything around Strings and localization
 150 */
 151
 152 /*!
 153         \defgroup tinyxml XML Parser
 154         \ingroup strings
 155
 156         Tiny XML - XML Parser
 157 */
 158
 159 /*!
 160         \defgroup jobs Asynchronous jobs
 161
 162         Threaded job execution
 163 */