diff --git a/SDL2pp/AudioDevice.hh b/SDL2pp/AudioDevice.hh index d1530d4..bda5b5f 100644 --- a/SDL2pp/AudioDevice.hh +++ b/SDL2pp/AudioDevice.hh @@ -1,6 +1,6 @@ /* libSDL2pp - C++11 bindings/wrapper for SDL2 - Copyright (C) 2014 Dmitry Marakasov + Copyright (C) 2014-2015 Dmitry Marakasov This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages @@ -45,10 +45,12 @@ class AudioSpec; class AudioDevice { public: //////////////////////////////////////////////////////////// - /// \ingroup audio - /// \headerfile SDL2pp/AudioDevice.hh /// \brief SDL2pp::AudioDevice lock /// + /// \ingroup audio + /// + /// \headerfile SDL2pp/AudioDevice.hh + /// /// Audio devices may be locked, which means that audio /// callback will not be called in a locked state, allowing /// to change data it accesses in a thread-safe way. @@ -101,7 +103,6 @@ public: //////////////////////////////////////////////////////////// /// \brief Create no-op lock /// - /// \details /// This may be initialized with real lock later with move /// assignment operator /// @@ -111,7 +112,6 @@ public: //////////////////////////////////////////////////////////// /// \brief Destructor /// - /// \details /// Releases the lock /// /// \see http://wiki.libsdl.org/SDL_UnlockAudioDevice diff --git a/SDL2pp/Surface.hh b/SDL2pp/Surface.hh index ae07167..cd26803 100644 --- a/SDL2pp/Surface.hh +++ b/SDL2pp/Surface.hh @@ -55,9 +55,11 @@ private: public: //////////////////////////////////////////////////////////// /// \brief SDL2pp::Surface lock + /// /// \ingroup rendering /// - /// \details + /// \headerfile SDL2pp/Surface.hh + /// /// For direct pixel access, SDL surface may need to be locked. /// This class represents the lock and controls its lifetime /// as the lock is released as soon as LockHandle is destroyed. @@ -83,7 +85,6 @@ public: //////////////////////////////////////////////////////////// /// \brief Create no-op lock /// - /// \details /// This may be initialized with real lock later with move /// assignment operator /// @@ -93,7 +94,6 @@ public: //////////////////////////////////////////////////////////// /// \brief Destructor /// - /// \details /// Releases the lock /// /// \see http://wiki.libsdl.org/SDL_UnlockSurface diff --git a/SDL2pp/Texture.hh b/SDL2pp/Texture.hh index e93c6b7..aed0281 100644 --- a/SDL2pp/Texture.hh +++ b/SDL2pp/Texture.hh @@ -1,6 +1,6 @@ /* libSDL2pp - C++11 bindings/wrapper for SDL2 - Copyright (C) 2013-2014 Dmitry Marakasov + Copyright (C) 2013-2015 Dmitry Marakasov This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages @@ -55,9 +55,11 @@ private: public: //////////////////////////////////////////////////////////// /// \brief SDL2pp::Texture lock + /// /// \ingroup rendering /// - /// \details + /// \headerfile SDL2pp/Texture.hh + /// /// Textures with SDL_TEXTUREACCESS_STREAMING access mode may /// be locked, which provides (writeonly) access to their raw /// pixel data. This may be used to update texture contents. @@ -113,7 +115,6 @@ public: //////////////////////////////////////////////////////////// /// \brief Create no-op lock /// - /// \details /// This may be initialized with real lock later with move /// assignment operator /// @@ -123,7 +124,6 @@ public: //////////////////////////////////////////////////////////// /// \brief Destructor /// - /// \details /// Releases the lock /// /// \see http://wiki.libsdl.org/SDL_UnlockTexture