/doxygen_resources/pages/mainpage.dox

http://github.com/xbmc/xbmc · Unknown · 192 lines · 151 code · 41 blank · 0 comment · 0 complexity · 36fa20437e0f55480e73980fba6b5532 MD5 · raw file

  1. /*! \file mainpage.dox
  2. \brief Introduction page
  3. \mainpage Introduction
  4. Welcome to the documentation of Kodi. This starting page is meant to help people find their
  5. way around the code.
  6. This documentation is a work in progress - only some of the code has thus far been documented
  7. and we welcome any and all input to documenting it further. Documentation serves both to help
  8. newcomers get to grips with the source quickly, and to highlight possible deficiencies in the
  9. code or interfaces. Due to the projects history you may find XBMC mentioned in the docs, this was
  10. the previous name of the project.
  11. Any help/suggestions are more than welcome.
  12. \section doxy_whatisxbmc What is Kodi?
  13. Kodi is a free, open source (GPL) multimedia player that runs on Linux, Mac OS X (10.4 and later),
  14. Windows, IOS and Android. See http://kodi.tv for more details.
  15. */
  16. // Groups definition
  17. /*!
  18. \defgroup jobs Asynchronous jobs
  19. Threaded job execution
  20. */
  21. /*!
  22. \defgroup guilib Guilib classes
  23. Guilib classes
  24. */
  25. /*!
  26. \defgroup graphics Graphics and Screen
  27. \ingroup guilib
  28. Everything around graphics and Screen
  29. */
  30. ^/*!
  31. \defgroup thumbs Thumbs
  32. \ingroup graphics
  33. Everything around the thumbs
  34. */
  35. /*!
  36. \defgroup textures Textures and Fonts
  37. \ingroup graphics
  38. Everything about textures and fonts
  39. */
  40. /*!
  41. \defgroup items Items
  42. \ingroup guilib
  43. Everything around items
  44. */
  45. /*!
  46. \defgroup labels Labels
  47. \ingroup guilib
  48. Everything around labels
  49. */
  50. /*!
  51. \defgroup lists Lists
  52. \ingroup guilib
  53. Everything around lists
  54. */
  55. /*!
  56. \defgroup strings Strings and Localization
  57. \ingroup guilib
  58. Everything around Strings and localization
  59. */
  60. /*!
  61. \defgroup tinyxml XML Parser
  62. \ingroup strings
  63. Tiny XML - XML Parser
  64. */
  65. /*!
  66. \defgroup winref Window Reference
  67. \ingroup guilib
  68. The window reference
  69. */
  70. /*!
  71. \defgroup winmsg Windows and Messages
  72. \ingroup winref
  73. Windows and messages
  74. */
  75. /*!
  76. \defgroup controls Controls
  77. \ingroup winref
  78. Control classes
  79. */
  80. /*!
  81. \defgroup winman Window Manager and Callbacks
  82. \ingroup winref
  83. Everything about window manager and callbacks
  84. */
  85. /*!
  86. \defgroup actionkeys Actions and Keys
  87. \ingroup winref
  88. Everything around action mapping and key processing
  89. */
  90. /*!
  91. \defgroup database Database
  92. Everything around the database
  93. */
  94. /*!
  95. \defgroup filesystem Filesystem
  96. Everything around the filesystem
  97. */
  98. /*!
  99. \defgroup input Input
  100. Everything around input
  101. */
  102. /*!
  103. \defgroup mouse Mouse
  104. \ingroup input
  105. Everything around mouse
  106. */
  107. /*!
  108. \defgroup touch Touch
  109. \ingroup input
  110. Everything around touch detection
  111. */
  112. /*!
  113. \defgroup touch_generic Touch
  114. \ingroup touch
  115. Everything around generic touch detection
  116. */
  117. /*!
  118. \defgroup interface Interfaces
  119. Everything around interfaces
  120. */
  121. /*!
  122. \defgroup info Info
  123. \ingroup interface
  124. Everything around the info interface
  125. */
  126. /*!
  127. \defgroup jsonrpc JSON-RPC
  128. \ingroup interface
  129. Everything around the json-rpc interface
  130. */
  131. /*!
  132. \defgroup jsonrpc JSON-RPC
  133. \ingroup interface
  134. Everything around the json-rpc interface
  135. */
  136. /*!
  137. \defgroup listproviders Listproviders
  138. Everything around the listproviders
  139. */
  140. /*!
  141. \defgroup music Music info
  142. Elements used in my music
  143. */
  144. /*!
  145. \defgroup settings Settings
  146. Everything around the settings
  147. */
  148. /*!
  149. \defgroup windows Windows
  150. Kodi windows
  151. */