TheCloud/libSDL2pp
1
0
Fork 0
mirror of https://github.com/libSDL2pp/libSDL2pp.git synced 2025-09-10 07:50:06 -04:00
Code Issues Packages Projects Releases Wiki Activity

Define documentation groups

Browse Source
This commit is contained in:
Dmitry Marakasov 2014-12-17 19:51:04 +03:00
parent 93ab413744
commit ff84056575
2 changed files with 65 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
SDL2pp/SDL2pp.hh
View File

@ -22,18 +22,74 @@
#ifndef SDL2PP_SDL2PP_HH #ifndef SDL2PP_SDL2PP_HH
#define SDL2PP_SDL2PP_HH #define SDL2PP_SDL2PP_HH
#include <SDL2pp/Exception.hh>
#include <SDL2pp/Config.hh> #include <SDL2pp/Config.hh>
////////////////////////////////////////////////////////////
/// \defgroup general
///
/// \brief SDL library initialization and shutdown functions
/// and error handling
///
////////////////////////////////////////////////////////////
#include <SDL2pp/SDL.hh> #include <SDL2pp/SDL.hh>
#include <SDL2pp/Exception.hh>
////////////////////////////////////////////////////////////
/// \defgroup audio
///
/// \brief Audio device management and audio playback
///
////////////////////////////////////////////////////////////
#include <SDL2pp/Audio.hh> #include <SDL2pp/Audio.hh>
#include <SDL2pp/Window.hh>
#include <SDL2pp/Renderer.hh>
#include <SDL2pp/Texture.hh>
#include <SDL2pp/Rect.hh>
#include <SDL2pp/Point.hh>
#include <SDL2pp/RWops.hh>
#include <SDL2pp/ExtraRWops.hh>
#include <SDL2pp/Wav.hh> #include <SDL2pp/Wav.hh>
////////////////////////////////////////////////////////////
/// \defgroup graphics
///
/// \brief Graphics output
///
////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////
/// \defgroup windows
///
/// \brief Display and window management
///
/// \ingroup graphics
///
////////////////////////////////////////////////////////////
#include <SDL2pp/Window.hh>
////////////////////////////////////////////////////////////
/// \defgroup rendering
///
/// \brief 2D accelerated rendering
///
/// \ingroup graphics
///
////////////////////////////////////////////////////////////
#include <SDL2pp/Renderer.hh>
#include <SDL2pp/Texture.hh>
////////////////////////////////////////////////////////////
/// \defgroup rect
///
/// \brief Rectangle and point functions
///
/// \ingroup graphics
///
////////////////////////////////////////////////////////////
#include <SDL2pp/Rect.hh>
#include <SDL2pp/Point.hh>
////////////////////////////////////////////////////////////
/// \defgroup io I/O abstraction
///
/// \brief Functions that extend file-like operations onto arbitrary
/// objects such as memory, streams, STL containers etc.
///
////////////////////////////////////////////////////////////
#include <SDL2pp/RWops.hh>
#include <SDL2pp/ExtraRWops.hh>
#endif #endif

2
SDL2pp/Wav.hh
View File

@ -125,7 +125,7 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class SDL2pp::Wav /// \class SDL2pp::Wav
/// \ingroup Audio /// \ingroup audio
/// ///
/// SDL2pp::Wav is a wrapper around basic SDL2 audio fragment /// SDL2pp::Wav is a wrapper around basic SDL2 audio fragment
/// handling functionality, basically SDL_LoadWAV and related /// handling functionality, basically SDL_LoadWAV and related