Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor improvements in sf::Window and sf::RenderWindow documentation

Browse Source
This commit is contained in:
Jan Haller 2014-03-22 12:56:05 +01:00
parent 185c09a95c
commit 9d5eb14dde
2 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/SFML/Graphics/RenderWindow.hpp
View File

@ -49,7 +49,7 @@ public :
/// \brief Default constructor /// \brief Default constructor
/// ///
/// This constructor doesn't actually create the window, /// This constructor doesn't actually create the window,
/// use the other constructors or call "create" to do so. /// use the other constructors or call create() to do so.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
RenderWindow(); RenderWindow();
@ -69,7 +69,7 @@ public :
/// ///
/// \param mode Video mode to use (defines the width, height and depth of the rendering area of the window) /// \param mode Video mode to use (defines the width, height and depth of the rendering area of the window)
/// \param title Title of the window /// \param title Title of the window
/// \param style Window style /// \param style %Window style, a bitwise OR combination of sf::Style enumerators
/// \param settings Additional settings for the underlying OpenGL context /// \param settings Additional settings for the underlying OpenGL context
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -81,12 +81,13 @@ public :
/// Use this constructor if you want to create an SFML /// Use this constructor if you want to create an SFML
/// rendering area into an already existing control. /// rendering area into an already existing control.
/// ///
/// The fourth parameter is an optional structure specifying /// The second parameter is an optional structure specifying
/// advanced OpenGL context settings such as antialiasing, /// advanced OpenGL context settings such as antialiasing,
/// depth-buffer bits, etc. You shouldn't care about these /// depth-buffer bits, etc. You shouldn't care about these
/// parameters for a regular usage of the graphics module. /// parameters for a regular usage of the graphics module.
/// ///
/// \param handle Platform-specific handle of the control /// \param handle Platform-specific handle of the control (\a HWND on
/// Windows, \a %Window on Linux/FreeBSD, \a NSWindow on OS X)
/// \param settings Additional settings for the underlying OpenGL context /// \param settings Additional settings for the underlying OpenGL context
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -95,7 +96,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Destructor /// \brief Destructor
/// ///
/// Closes the window and free all the resources attached to it. /// Closes the window and frees all the resources attached to it.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual ~RenderWindow(); virtual ~RenderWindow();

24
include/SFML/Window/Window.hpp
View File

@ -62,7 +62,7 @@ public :
/// \brief Default constructor /// \brief Default constructor
/// ///
/// This constructor doesn't actually create the window, /// This constructor doesn't actually create the window,
/// use the other constructors or call "create" to do so. /// use the other constructors or call create() to do so.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Window(); Window();
@ -82,7 +82,7 @@ public :
/// ///
/// \param mode Video mode to use (defines the width, height and depth of the rendering area of the window) /// \param mode Video mode to use (defines the width, height and depth of the rendering area of the window)
/// \param title Title of the window /// \param title Title of the window
/// \param style Window style /// \param style %Window style, a bitwise OR combination of sf::Style enumerators
/// \param settings Additional settings for the underlying OpenGL context /// \param settings Additional settings for the underlying OpenGL context
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -98,7 +98,8 @@ public :
/// advanced OpenGL context settings such as antialiasing, /// advanced OpenGL context settings such as antialiasing,
/// depth-buffer bits, etc. /// depth-buffer bits, etc.
/// ///
/// \param handle Platform-specific handle of the control /// \param handle Platform-specific handle of the control (\a HWND on
/// Windows, \a %Window on Linux/FreeBSD, \a NSWindow on OS X)
/// \param settings Additional settings for the underlying OpenGL context /// \param settings Additional settings for the underlying OpenGL context
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -107,7 +108,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Destructor /// \brief Destructor
/// ///
/// Closes the window and free all the resources attached to it. /// Closes the window and frees all the resources attached to it.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual ~Window(); virtual ~Window();
@ -119,9 +120,13 @@ public :
/// If \a style contains Style::Fullscreen, then \a mode /// If \a style contains Style::Fullscreen, then \a mode
/// must be a valid video mode. /// must be a valid video mode.
/// ///
/// The fourth parameter is an optional structure specifying
/// advanced OpenGL context settings such as antialiasing,
/// depth-buffer bits, etc.
///
/// \param mode Video mode to use (defines the width, height and depth of the rendering area of the window) /// \param mode Video mode to use (defines the width, height and depth of the rendering area of the window)
/// \param title Title of the window /// \param title Title of the window
/// \param style Window style /// \param style %Window style, a bitwise OR combination of sf::Style enumerators
/// \param settings Additional settings for the underlying OpenGL context /// \param settings Additional settings for the underlying OpenGL context
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -134,7 +139,12 @@ public :
/// rendering area into an already existing control. /// rendering area into an already existing control.
/// If the window was already created, it closes it first. /// If the window was already created, it closes it first.
/// ///
/// \param handle Platform-specific handle of the control /// The second parameter is an optional structure specifying
/// advanced OpenGL context settings such as antialiasing,
/// depth-buffer bits, etc.
///
/// \param handle Platform-specific handle of the control (\a HWND on
/// Windows, \a %Window on Linux/FreeBSD, \a NSWindow on OS X)
/// \param settings Additional settings for the underlying OpenGL context /// \param settings Additional settings for the underlying OpenGL context
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -417,6 +427,8 @@ public :
/// You shouldn't need to use this function, unless you have /// You shouldn't need to use this function, unless you have
/// very specific stuff to implement that SFML doesn't support, /// very specific stuff to implement that SFML doesn't support,
/// or implement a temporary workaround until a bug is fixed. /// or implement a temporary workaround until a bug is fixed.
/// The type is \a HWND on Windows, \a %Window on Linux/FreeBSD
/// and \a NSWindow on OS X.
/// ///
/// \return System handle of the window /// \return System handle of the window
/// ///