TheCloud/libSDL2pp
1
0
Fork 0
mirror of https://github.com/libSDL2pp/libSDL2pp.git synced 2025-08-05 20:05:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Minor documentation fixes

Browse Source
This commit is contained in:
Dmitry Marakasov 2015-01-10 23:02:36 +03:00
parent 7a1f6d8f0d
commit da2b2441f3
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
SDL2pp/AudioDevice.hh
View File

@ -1,6 +1,6 @@
/* /*
libSDL2pp - C++11 bindings/wrapper for SDL2 libSDL2pp - C++11 bindings/wrapper for SDL2
Copyright (C) 2014 Dmitry Marakasov <amdmi3@amdmi3.ru> Copyright (C) 2014-2015 Dmitry Marakasov <amdmi3@amdmi3.ru>
This software is provided 'as-is', without any express or implied This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages warranty. In no event will the authors be held liable for any damages
@ -45,10 +45,12 @@ class AudioSpec;
class AudioDevice { class AudioDevice {
public: public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \ingroup audio
/// \headerfile SDL2pp/AudioDevice.hh
/// \brief SDL2pp::AudioDevice lock /// \brief SDL2pp::AudioDevice lock
/// ///
/// \ingroup audio
///
/// \headerfile SDL2pp/AudioDevice.hh
///
/// Audio devices may be locked, which means that audio /// Audio devices may be locked, which means that audio
/// callback will not be called in a locked state, allowing /// callback will not be called in a locked state, allowing
/// to change data it accesses in a thread-safe way. /// to change data it accesses in a thread-safe way.
@ -101,7 +103,6 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create no-op lock /// \brief Create no-op lock
/// ///
/// \details
/// This may be initialized with real lock later with move /// This may be initialized with real lock later with move
/// assignment operator /// assignment operator
/// ///
@ -111,7 +112,6 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Destructor /// \brief Destructor
/// ///
/// \details
/// Releases the lock /// Releases the lock
/// ///
/// \see http://wiki.libsdl.org/SDL_UnlockAudioDevice /// \see http://wiki.libsdl.org/SDL_UnlockAudioDevice

6
SDL2pp/Surface.hh
View File

@ -55,9 +55,11 @@ private:
public: public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief SDL2pp::Surface lock /// \brief SDL2pp::Surface lock
///
/// \ingroup rendering /// \ingroup rendering
/// ///
/// \details /// \headerfile SDL2pp/Surface.hh
///
/// For direct pixel access, SDL surface may need to be locked. /// For direct pixel access, SDL surface may need to be locked.
/// This class represents the lock and controls its lifetime /// This class represents the lock and controls its lifetime
/// as the lock is released as soon as LockHandle is destroyed. /// as the lock is released as soon as LockHandle is destroyed.
@ -83,7 +85,6 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create no-op lock /// \brief Create no-op lock
/// ///
/// \details
/// This may be initialized with real lock later with move /// This may be initialized with real lock later with move
/// assignment operator /// assignment operator
/// ///
@ -93,7 +94,6 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Destructor /// \brief Destructor
/// ///
/// \details
/// Releases the lock /// Releases the lock
/// ///
/// \see http://wiki.libsdl.org/SDL_UnlockSurface /// \see http://wiki.libsdl.org/SDL_UnlockSurface

8
SDL2pp/Texture.hh
View File

@ -1,6 +1,6 @@
/* /*
libSDL2pp - C++11 bindings/wrapper for SDL2 libSDL2pp - C++11 bindings/wrapper for SDL2
Copyright (C) 2013-2014 Dmitry Marakasov <amdmi3@amdmi3.ru> Copyright (C) 2013-2015 Dmitry Marakasov <amdmi3@amdmi3.ru>
This software is provided 'as-is', without any express or implied This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages warranty. In no event will the authors be held liable for any damages
@ -55,9 +55,11 @@ private:
public: public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief SDL2pp::Texture lock /// \brief SDL2pp::Texture lock
///
/// \ingroup rendering /// \ingroup rendering
/// ///
/// \details /// \headerfile SDL2pp/Texture.hh
///
/// Textures with SDL_TEXTUREACCESS_STREAMING access mode may /// Textures with SDL_TEXTUREACCESS_STREAMING access mode may
/// be locked, which provides (writeonly) access to their raw /// be locked, which provides (writeonly) access to their raw
/// pixel data. This may be used to update texture contents. /// pixel data. This may be used to update texture contents.
@ -113,7 +115,6 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create no-op lock /// \brief Create no-op lock
/// ///
/// \details
/// This may be initialized with real lock later with move /// This may be initialized with real lock later with move
/// assignment operator /// assignment operator
/// ///
@ -123,7 +124,6 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Destructor /// \brief Destructor
/// ///
/// \details
/// Releases the lock /// Releases the lock
/// ///
/// \see http://wiki.libsdl.org/SDL_UnlockTexture /// \see http://wiki.libsdl.org/SDL_UnlockTexture