Merge pull request #110 from Vraiment/fix_doc

Added some missing doc info
This commit is contained in:
Dmitry Marakasov 2017-07-26 19:07:32 +03:00 committed by GitHub
commit 7cfc30970b
2 changed files with 12 additions and 0 deletions

View File

@ -217,6 +217,8 @@ public:
/// ///
/// \param[in] rwops RWops used to access an image file /// \param[in] rwops RWops used to access an image file
/// ///
/// \throws SDL2pp::Exception
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
explicit Surface(RWops& rwops); explicit Surface(RWops& rwops);
@ -225,6 +227,8 @@ public:
/// ///
/// \param[in] filename Path to an image file /// \param[in] filename Path to an image file
/// ///
/// \throws SDL2pp::Exception
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
explicit Surface(const std::string& filename); explicit Surface(const std::string& filename);
#endif #endif

View File

@ -483,6 +483,8 @@ public:
/// ///
/// \returns Index of the display containing the center of the window /// \returns Index of the display containing the center of the window
/// ///
/// \throws SDL2pp::Exception
///
/// \see http://wiki.libsdl.org/SDL_GetWindowDisplayIndex /// \see http://wiki.libsdl.org/SDL_GetWindowDisplayIndex
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -495,6 +497,8 @@ public:
/// \param[out] mode SDL_DisplayMode structure filled in with the /// \param[out] mode SDL_DisplayMode structure filled in with the
/// fullscreen display mode /// fullscreen display mode
/// ///
/// \throws SDL2pp::Exception
///
/// \see http://wiki.libsdl.org/SDL_GetWindowDisplayMode /// \see http://wiki.libsdl.org/SDL_GetWindowDisplayMode
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -544,6 +548,8 @@ public:
/// ///
/// \returns Reference to self /// \returns Reference to self
/// ///
/// \throws SDL2pp::Exception
///
/// \see http://wiki.libsdl.org/SDL_SetWindowOpacity /// \see http://wiki.libsdl.org/SDL_SetWindowOpacity
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -554,6 +560,8 @@ public:
/// ///
/// \returns Opacity value (0.0f - transparent, 1.0f - opaque) /// \returns Opacity value (0.0f - transparent, 1.0f - opaque)
/// ///
/// \throws SDL2pp:Exception
///
/// \see http://wiki.libsdl.org/SDL_GetWindowOpacity /// \see http://wiki.libsdl.org/SDL_GetWindowOpacity
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////