From ff840565755b1387a89b705504e862ce2960ac91 Mon Sep 17 00:00:00 2001 From: Dmitry Marakasov Date: Wed, 17 Dec 2014 19:51:04 +0300 Subject: [PATCH] Define documentation groups --- SDL2pp/SDL2pp.hh | 72 ++++++++++++++++++++++++++++++++++++++++++------ SDL2pp/Wav.hh | 2 +- 2 files changed, 65 insertions(+), 9 deletions(-) diff --git a/SDL2pp/SDL2pp.hh b/SDL2pp/SDL2pp.hh index 8fa7c19..ba1d6f6 100644 --- a/SDL2pp/SDL2pp.hh +++ b/SDL2pp/SDL2pp.hh @@ -22,18 +22,74 @@ #ifndef SDL2PP_SDL2PP_HH #define SDL2PP_SDL2PP_HH -#include #include +//////////////////////////////////////////////////////////// +/// \defgroup general +/// +/// \brief SDL library initialization and shutdown functions +/// and error handling +/// +//////////////////////////////////////////////////////////// #include +#include + +//////////////////////////////////////////////////////////// +/// \defgroup audio +/// +/// \brief Audio device management and audio playback +/// +//////////////////////////////////////////////////////////// #include -#include -#include -#include -#include -#include -#include -#include #include +//////////////////////////////////////////////////////////// +/// \defgroup graphics +/// +/// \brief Graphics output +/// +//////////////////////////////////////////////////////////// + +//////////////////////////////////////////////////////////// +/// \defgroup windows +/// +/// \brief Display and window management +/// +/// \ingroup graphics +/// +//////////////////////////////////////////////////////////// +#include + +//////////////////////////////////////////////////////////// +/// \defgroup rendering +/// +/// \brief 2D accelerated rendering +/// +/// \ingroup graphics +/// +//////////////////////////////////////////////////////////// +#include +#include + +//////////////////////////////////////////////////////////// +/// \defgroup rect +/// +/// \brief Rectangle and point functions +/// +/// \ingroup graphics +/// +//////////////////////////////////////////////////////////// +#include +#include + +//////////////////////////////////////////////////////////// +/// \defgroup io I/O abstraction +/// +/// \brief Functions that extend file-like operations onto arbitrary +/// objects such as memory, streams, STL containers etc. +/// +//////////////////////////////////////////////////////////// +#include +#include + #endif diff --git a/SDL2pp/Wav.hh b/SDL2pp/Wav.hh index 4f76252..ce49263 100644 --- a/SDL2pp/Wav.hh +++ b/SDL2pp/Wav.hh @@ -125,7 +125,7 @@ public: //////////////////////////////////////////////////////////// /// \class SDL2pp::Wav -/// \ingroup Audio +/// \ingroup audio /// /// SDL2pp::Wav is a wrapper around basic SDL2 audio fragment /// handling functionality, basically SDL_LoadWAV and related