TheCloud/libSDL2pp
1
0
Fork 0
mirror of https://github.com/libSDL2pp/libSDL2pp.git synced 2025-08-03 10:55:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add in/out specifiers to param documentation

Browse Source
This commit is contained in:
Dmitry Marakasov 2015-01-12 21:43:28 +03:00
parent 5571d5c647
commit 0f1dd26ebd
16 changed files with 389 additions and 389 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
SDL2pp/AudioDevice.hh
View File

@ -90,7 +90,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create lock for specific SDL2pp::AudioDevice
///
/// \param device Pointer to audio device to lock
/// \param[in] device Pointer to audio device to lock
///
/// This operation locks a device, which remains locked
/// until LockHandle is destroyed
@ -125,7 +125,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::AudioDevice::LockHandle to move data from
/// \param[in] other SDL2pp::AudioDevice::LockHandle to move data from
///
////////////////////////////////////////////////////////////
LockHandle(LockHandle&& other) noexcept;
@ -133,7 +133,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment operator
///
/// \param other SDL2pp::AudioDevice::LockHandle to move data from
/// \param[in] other SDL2pp::AudioDevice::LockHandle to move data from
///
/// \returns Reference to self
///
@ -143,7 +143,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Copy constructor
///
/// \param other SDL2pp::AudioDevice::LockHandle to copy data from
/// \param[in] other SDL2pp::AudioDevice::LockHandle to copy data from
///
////////////////////////////////////////////////////////////
LockHandle(const LockHandle& other);
@ -151,7 +151,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Assignment operator
///
/// \param other SDL2pp::AudioDevice::LockHandle to copy data from
/// \param[in] other SDL2pp::AudioDevice::LockHandle to copy data from
///
/// \returns Reference to self
///
@ -179,11 +179,11 @@ public:
////////////////////////////////////////////////////////////
/// \brief Open audio device with specified output format
///
/// \param device Name of the device to open
/// \param iscapture Non-zero to open device for recording
/// (SDL2 doesn't support this yet)
/// \param spec Audio output format
/// \param callback Callback which will feed audio to the device
/// \param[in] device Name of the device to open
/// \param[in] iscapture Non-zero to open device for recording
/// (SDL2 doesn't support this yet)
/// \param[in] spec Audio output format
/// \param[in] callback Callback which will feed audio to the device
///
/// \throws SDL2pp::Exception
///
@ -195,13 +195,13 @@ public:
////////////////////////////////////////////////////////////
/// \brief Open audio device with desired output format
///
/// \param device Name of the device to open
/// \param iscapture Non-zero to open device for recording
/// (SDL2 doesn't support this yet)
/// \param allowed_changes Flag mask specifying which audio
/// format properties may change
/// \param spec Desired audio output format (may be changed)
/// \param callback Callback which will feed audio to the device
/// \param[in] device Name of the device to open
/// \param[in] iscapture Non-zero to open device for recording
/// (SDL2 doesn't support this yet)
/// \param[in] allowed_changes Flag mask specifying which audio
/// format properties may change
/// \param[in,out] spec Desired audio output format (may be changed)
/// \param[in] callback Callback which will feed audio to the device
///
/// \throws SDL2pp::Exception
///
@ -219,7 +219,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::AudioDevice to move data from
/// \param[in] other SDL2pp::AudioDevice to move data from
///
////////////////////////////////////////////////////////////
AudioDevice(AudioDevice&& other) noexcept;
@ -227,7 +227,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::AudioDevice to move data from
/// \param[in] other SDL2pp::AudioDevice to move data from
///
/// \returns Reference to self
///
@ -261,7 +261,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Pause or unpause audio playback
///
/// \param pause_on Whether audio should be paused
/// \param[in] pause_on Whether audio should be paused
///
/// \see http://wiki.libsdl.org/SDL_PauseAudioDevice
///
@ -281,7 +281,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Replace audio callback
///
/// \param callback New audio callback
/// \param[in] callback New audio callback
///
////////////////////////////////////////////////////////////
void ChangeCallback(AudioCallback&& callback);
@ -304,8 +304,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Queue more audio for a non-callback device
///
/// \param data Data to queue for later playback
/// \param len Data length in bytes (not samples!)
/// \param[in] data Data to queue for later playback
/// \param[in] len Data length in bytes (not samples!)
///
/// \throws SDL2pp::Exception
///

16
SDL2pp/AudioSpec.hh
View File

@ -52,10 +52,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create audio format specification with given properties
///
/// \param freq Sampling frequency in samples/second
/// \param format Sample format, see http://wiki.libsdl.org/SDL_AudioSpec#Remarks
/// \param channels Number of separate audio channels
/// \param samples Audio buffer size in samples (power of 2)
/// \param[in] freq Sampling frequency in samples/second
/// \param[in] format Sample format, see http://wiki.libsdl.org/SDL_AudioSpec#Remarks
/// \param[in] channels Number of separate audio channels
/// \param[in] samples Audio buffer size in samples (power of 2)
///
/// \see http://wiki.libsdl.org/SDL_AudioSpec#Remarks
///
@ -71,7 +71,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::AudioSpec object to move data from
/// \param[in] other SDL2pp::AudioSpec object to move data from
///
////////////////////////////////////////////////////////////
AudioSpec(AudioSpec&& other);
@ -79,7 +79,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment operator
///
/// \param other SDL2pp::AudioSpec object to move data from
/// \param[in] other SDL2pp::AudioSpec object to move data from
///
/// \returns Reference to self
///
@ -113,7 +113,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Merges audio format changes from another SDL2pp::AudioSpec
///
/// \param obtained SDL2pp::AudioSpec to merge data from
/// \param[in] obtained SDL2pp::AudioSpec to merge data from
///
////////////////////////////////////////////////////////////
void MergeChanges(const SDL_AudioSpec& obtained);
@ -121,7 +121,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Checks if format of another SDL2pp::AudioSpec is the same
///
/// \param other SDL2pp::AudioSpec to compare to
/// \param[in] other SDL2pp::AudioSpec to compare to
///
////////////////////////////////////////////////////////////
bool IsSameFormat(const AudioSpec& other) const;

20
SDL2pp/ContainerRWops.hh
View File

@ -75,7 +75,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct ContainerRWops for specified container
///
/// \param container Container to use
/// \param[in] container Container to use
///
////////////////////////////////////////////////////////////
ContainerRWops(C& container) : container_(container), position_(0) {
@ -84,9 +84,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Seek within the container
///
/// \param offset Offset in bytes, relative to whence location; can
/// be negative
/// \param whence Any of RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
/// \param[in] offset Offset in bytes, relative to whence location; can
/// be negative
/// \param[in] whence Any of RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
///
/// \returns Final offset in the container after the seek or -1 on error
///
@ -114,9 +114,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Read from a container
///
/// \param ptr Pointer to a buffer to read data into
/// \param size Size of each object to read, in bytes
/// \param maxnum Maximum number of objects to be read
/// \param[in] ptr Pointer to a buffer to read data into
/// \param[in] size Size of each object to read, in bytes
/// \param[in] maxnum Maximum number of objects to be read
///
/// \returns Number of objects read, or 0 at end of file
///
@ -140,9 +140,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Write to container
///
/// \param ptr Pointer to a buffer containing data to write
/// \param size Size of each object to write, in bytes
/// \param num Number of objects to be write
/// \param[in] ptr Pointer to a buffer containing data to write
/// \param[in] size Size of each object to write, in bytes
/// \param[in] num Number of objects to be write
///
/// \returns Number of objects written
///

2
SDL2pp/Exception.hh
View File

@ -75,7 +75,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct exception, storing result of SDL_GetError()
///
/// \param what User-specified explanatory string
/// \param[in] what User-specified explanatory string
///
////////////////////////////////////////////////////////////
Exception(const char* what = "");

120
SDL2pp/Font.hh
View File

@ -52,7 +52,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct from existing TTF_Font structure
///
/// \param font Existing TTF_Font to manage
/// \param[in] font Existing TTF_Font to manage
///
////////////////////////////////////////////////////////////
Font(TTF_Font* font);
@ -60,9 +60,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Loads font from .ttf or .fon file
///
/// \param file Pointer File name to load font from
/// \param ptsize %Point size (based on 72DPI) to load font as. This basically translates to pixel height
/// \param index Choose a font face from a file containing multiple font faces. The first face is always index 0
/// \param[in] file Pointer File name to load font from
/// \param[in] ptsize %Point size (based on 72DPI) to load font as. This basically translates to pixel height
/// \param[in] index Choose a font face from a file containing multiple font faces. The first face is always index 0
///
/// \throws SDL2pp::Exception
///
@ -75,9 +75,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Loads font with RWops
///
/// \param rwops RWops to load font from
/// \param ptsize %Point size (based on 72DPI) to load font as. This basically translates to pixel height
/// \param index Choose a font face from a file containing multiple font faces. The first face is always index 0
/// \param[in] rwops RWops to load font from
/// \param[in] ptsize %Point size (based on 72DPI) to load font as. This basically translates to pixel height
/// \param[in] index Choose a font face from a file containing multiple font faces. The first face is always index 0
///
/// \throws SDL2pp::Exception
///
@ -98,7 +98,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::Font object to move data from
/// \param[in] other SDL2pp::Font object to move data from
///
////////////////////////////////////////////////////////////
Font(Font&& other) noexcept;
@ -106,7 +106,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment
///
/// \param other SDL2pp::Font object to move data from
/// \param[in] other SDL2pp::Font object to move data from
///
/// \returns Reference to self
///
@ -153,10 +153,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the rendering style of the loaded font
///
/// \param style The style as a bitmask composed of the following masks:
/// TTF_STYLE_BOLD, TTF_STYLE_ITALIC, TTF_STYLE_UNDERLINE,
/// TTF_STYLE_STRIKETHROUGH. If no style is desired then use
/// TTF_STYLE_NORMAL, which is the default.
/// \param[in] style The style as a bitmask composed of the following masks:
/// TTF_STYLE_BOLD, TTF_STYLE_ITALIC, TTF_STYLE_UNDERLINE,
/// TTF_STYLE_STRIKETHROUGH. If no style is desired then use
/// TTF_STYLE_NORMAL, which is the default.
///
/// \note This will flush the internal cache of previously rendered
/// glyphs, even if there is no change in style, so it may be best
@ -195,8 +195,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the outline pixel width of the loaded font
///
/// \param outline The size of outline desired, in pixels.
/// Use 0 (zero) to turn off outlining.
/// \param[in] outline The size of outline desired, in pixels.
/// Use 0 (zero) to turn off outlining.
///
/// \note This will flush the internal cache of previously rendered
/// glyphs, even if there is no change in outline size, so it may be best
@ -222,9 +222,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the hinting of the loaded font
///
/// \param hinting The hinting setting desired, which is one of:
/// TTF_HINTING_NORMAL, TTF_HINTING_LIGHT, TTF_HINTING_MONO,
/// TTF_HINTING_NONE. The default is TTF_HINTING_NORMAL
/// \param[in] hinting The hinting setting desired, which is one of:
/// TTF_HINTING_NORMAL, TTF_HINTING_LIGHT, TTF_HINTING_MONO,
/// TTF_HINTING_NONE. The default is TTF_HINTING_NORMAL
///
/// You should experiment with this setting if you know which font
/// you are using beforehand, especially when using smaller sized
@ -254,8 +254,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set whether to use kerning when rendering the loaded font
///
/// \param allowed False to disable kerning, true to enable kerning.
/// The default is true, enabled
/// \param[in] allowed False to disable kerning, true to enable kerning.
/// The default is true, enabled
///
/// Set whether to use kerning when rendering the loaded font.
/// This has no effect on individual glyphs, but rather when
@ -399,7 +399,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get the status of the availability of the glyph from the loaded font
///
/// \param ch Unicode character to test glyph availability of
/// \param[in] ch Unicode character to test glyph availability of
///
/// \returns The index of the glyph for ch in font, or 0 for an undefined character code
///
@ -411,12 +411,12 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get glyph metrics of the UNICODE char
///
/// \param ch UNICODE char to get the glyph metrics for
/// \param minx Variable to store the returned minimum X offset into
/// \param maxx Variable to store the returned maximum X offset into
/// \param miny Variable to store the returned minimum Y offset into
/// \param maxy Variable to store the returned maximum Y offset into
/// \param advance Variable to store the returned advance offset into
/// \param[out] ch UNICODE char to get the glyph metrics for
/// \param[out] minx Variable to store the returned minimum X offset into
/// \param[out] maxx Variable to store the returned maximum X offset into
/// \param[out] miny Variable to store the returned minimum Y offset into
/// \param[out] maxy Variable to store the returned maximum Y offset into
/// \param[out] advance Variable to store the returned advance offset into
///
/// \throws SDL2pp::Exception
///
@ -429,7 +429,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get rect part of glyph metrics of the UNICODE char
///
/// \param ch UNICODE char to get the glyph metrics for
/// \param[in] ch UNICODE char to get the glyph metrics for
///
/// \returns Rect representing glyph offset info
///
@ -444,7 +444,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get advance part of glyph metrics of the UNICODE char
///
/// \param ch UNICODE char to get the glyph metrics for
/// \param[in] ch UNICODE char to get the glyph metrics for
///
/// \returns Advance offset into
///
@ -459,7 +459,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Calculate the resulting surface size of the LATIN1 encoded text rendered using font
///
/// \param text String to size up
/// \param[in] text String to size up
///
/// \returns Point representing dimensions of the rendered text
///
@ -477,7 +477,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Calculate the resulting surface size of the UTF8 encoded text rendered using font
///
/// \param text UTF8 encoded string to size up
/// \param[in] text UTF8 encoded string to size up
///
/// \returns Point representing dimensions of the rendered text
///
@ -495,7 +495,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Calculate the resulting surface size of the UNICODE encoded text rendered using font
///
/// \param text UNICODE null terminated string to size up
/// \param[in] text UNICODE null terminated string to size up
///
/// \returns Point representing dimensions of the rendered text
///
@ -513,8 +513,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render LATIN1 text using solid mode
///
/// \param text LATIN1 string to render
/// \param fg Color to render the text in
/// \param[in] text LATIN1 string to render
/// \param[in] fg Color to render the text in
///
/// \returns Surface containing rendered text
///
@ -528,8 +528,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render UTF8 text using solid mode
///
/// \param text UTF8 string to render
/// \param fg Color to render the text in
/// \param[in] text UTF8 string to render
/// \param[in] fg Color to render the text in
///
/// \returns Surface containing rendered text
///
@ -543,8 +543,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render UNICODE encoded text using solid mode
///
/// \param text UNICODE encoded string to render
/// \param fg Color to render the text in
/// \param[in] text UNICODE encoded string to render
/// \param[in] fg Color to render the text in
///
/// \returns Surface containing rendered text
///
@ -558,8 +558,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render the glyph for UNICODE character using solid mode
///
/// \param ch UNICODE character to render
/// \param fg Color to render the glyph in
/// \param[in] ch UNICODE character to render
/// \param[in] fg Color to render the glyph in
///
/// \returns Surface containing rendered text
///
@ -573,9 +573,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render LATIN1 text using shaded mode
///
/// \param text LATIN1 string to render
/// \param fg Color to render the text in
/// \param bg Color to render the background box in
/// \param[in] text LATIN1 string to render
/// \param[in] fg Color to render the text in
/// \param[in] bg Color to render the background box in
///
/// \returns Surface containing rendered text
///
@ -589,9 +589,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render UTF8 text using shaded mode
///
/// \param text UTF8 string to render
/// \param fg Color to render the text in
/// \param bg Color to render the background box in
/// \param[in] text UTF8 string to render
/// \param[in] fg Color to render the text in
/// \param[in] bg Color to render the background box in
///
/// \returns Surface containing rendered text
///
@ -605,9 +605,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render UNICODE encoded text using shaded mode
///
/// \param text UNICODE encoded string to render
/// \param fg Color to render the text in
/// \param bg Color to render the background box in
/// \param[in] text UNICODE encoded string to render
/// \param[in] fg Color to render the text in
/// \param[in] bg Color to render the background box in
///
/// \returns Surface containing rendered text
///
@ -621,9 +621,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render the glyph for UNICODE character using shaded mode
///
/// \param ch UNICODE character to render
/// \param fg Color to render the glyph in
/// \param bg Color to render the background box in
/// \param[in] ch UNICODE character to render
/// \param[in] fg Color to render the glyph in
/// \param[in] bg Color to render the background box in
///
/// \returns Surface containing rendered text
///
@ -637,8 +637,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render LATIN1 text using blended mode
///
/// \param text LATIN1 string to render
/// \param fg Color to render the text in
/// \param[in] text LATIN1 string to render
/// \param[in] fg Color to render the text in
///
/// \returns Surface containing rendered text
///
@ -652,8 +652,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render UTF8 text using blended mode
///
/// \param text UTF8 string to render
/// \param fg Color to render the text in
/// \param[in] text UTF8 string to render
/// \param[in] fg Color to render the text in
///
/// \returns Surface containing rendered text
///
@ -667,8 +667,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render UNICODE encoded text using blended mode
///
/// \param text UNICODE encoded string to render
/// \param fg Color to render the text in
/// \param[in] text UNICODE encoded string to render
/// \param[in] fg Color to render the text in
///
/// \returns Surface containing rendered text
///
@ -682,8 +682,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Render the glyph for UNICODE character using blended mode
///
/// \param ch UNICODE character to render
/// \param fg Color to render the glyph in
/// \param[in] ch UNICODE character to render
/// \param[in] fg Color to render the glyph in
///
/// \returns Surface containing rendered text
///

30
SDL2pp/Point.hh
View File

@ -54,7 +54,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct a point from existing SDL_Point
///
/// \param point Existing SDL_Point
/// \param[in] point Existing SDL_Point
///
////////////////////////////////////////////////////////////
Point(const SDL_Point& point);
@ -62,8 +62,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct the point from given coordinates
///
/// \param nx X coordinate
/// \param ny Y coordinate
/// \param[in] nx X coordinate
/// \param[in] ny Y coordinate
///
////////////////////////////////////////////////////////////
Point(int nx, int ny);
@ -99,7 +99,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Equality operator
///
/// \param other Point to compare to
/// \param[in] other Point to compare to
///
/// \returns True if two points are identical
///
@ -109,7 +109,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Inequality operator
///
/// \param other Point to compare to
/// \param[in] other Point to compare to
///
/// \returns True if two points are not identical
///
@ -127,7 +127,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set X coordinate of the point
///
/// \param nx New X coordinate value
/// \param[in] nx New X coordinate value
///
////////////////////////////////////////////////////////////
void SetX(int nx);
@ -143,7 +143,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set Y coordinate of the point
///
/// \param ny New Y coordinate value
/// \param[in] ny New Y coordinate value
///
////////////////////////////////////////////////////////////
void SetY(int ny);
@ -151,7 +151,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get point's memberwise addition with another point
///
/// \param other Point to add
/// \param[in] other Point to add
///
/// \returns New Point representing memberwise addition with another point
///
@ -161,7 +161,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get point's memberwise subtraction with another point
///
/// \param other Point to subtract
/// \param[in] other Point to subtract
///
/// \returns New Point representing memberwise subtraction of another point
///
@ -171,7 +171,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get point's memberwise division by an integer
///
/// \param value Divisor
/// \param[in] value Divisor
///
/// \returns New Point representing memberwise division of point by and integer
///
@ -181,7 +181,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get point's memberwise multiplication by an integer
///
/// \param value Multiplier
/// \param[in] value Multiplier
///
/// \returns New Point representing memberwise multiplication of point by an integer
///
@ -191,7 +191,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Memberwise add another point
///
/// \param other Point to add to the current one
/// \param[in] other Point to add to the current one
///
/// \returns Reference to self
///
@ -201,7 +201,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Memberwise subtract another point
///
/// \param other Point to subtract from the current one
/// \param[in] other Point to subtract from the current one
///
/// \returns Reference to self
///
@ -211,7 +211,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Memberwise divide by an integer
///
/// \param value Divisor
/// \param[in] value Divisor
///
/// \returns Reference to self
///
@ -221,7 +221,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Memberwise multiply by an integer
///
/// \param value Multiplier
/// \param[in] value Multiplier
///
/// \returns Reference to self
///

74
SDL2pp/RWops.hh
View File

@ -55,9 +55,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Seek within the data stream
///
/// \param offset Offset in bytes, relative to whence location; can
/// be negative
/// \param whence Any of RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
/// \param[in] offset Offset in bytes, relative to whence location; can
/// be negative
/// \param[in] whence Any of RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
///
/// \returns Final offset in the data stream after the seek or -1 on error
///
@ -69,9 +69,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Read from a data stream
///
/// \param ptr Pointer to a buffer to read data into
/// \param size Size of each object to read, in bytes
/// \param maxnum Maximum number of objects to be read
/// \param[in] ptr Pointer to a buffer to read data into
/// \param[in] size Size of each object to read, in bytes
/// \param[in] maxnum Maximum number of objects to be read
///
/// \returns Number of objects read, or 0 at error or end of file
///
@ -83,9 +83,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Write to a data stream
///
/// \param ptr Pointer to a buffer containing data to write
/// \param size Size of each object to write, in bytes
/// \param num Maximum number of objects to be write
/// \param[in] ptr Pointer to a buffer containing data to write
/// \param[in] size Size of each object to write, in bytes
/// \param[in] num Maximum number of objects to be write
///
/// \returns Number of objects written, which will be less than num on error
///
@ -163,9 +163,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create RWops working through stdio's FILE*
///
/// \param file Pointer to stdio's FILE type
/// \param autoclose True to take ownership of given FILE and
/// close it on RWops destruction
/// \param[in] file Pointer to stdio's FILE type
/// \param[in] autoclose True to take ownership of given FILE and
/// close it on RWops destruction
///
/// \returns Created RWops
///
@ -177,8 +177,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create RWops working with a constant memory chunk
///
/// \param mem Pointer to the memory to work with
/// \param size Size of a memory chunk
/// \param[in] mem Pointer to the memory to work with
/// \param[in] size Size of a memory chunk
///
/// \returns Created RWops
///
@ -190,8 +190,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create RWops working with a memory chunk
///
/// \param mem Pointer to the memory to work with
/// \param size Size of a memory chunk
/// \param[in] mem Pointer to the memory to work with
/// \param[in] size Size of a memory chunk
///
/// \returns Created RWops
///
@ -203,8 +203,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create RWops working with plain file
///
/// \param file Path to file
/// \param mode Open mode in stdio way
/// \param[in] file Path to file
/// \param[in] mode Open mode in stdio way
///
/// \returns Created RWops
///
@ -216,7 +216,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create RWops from existing SDL2 SDL_RWops structure
///
/// \param rwops Pointer to SDL_RWops to use
/// \param[in] rwops Pointer to SDL_RWops to use
///
////////////////////////////////////////////////////////////
RWops(SDL_RWops* rwops);
@ -224,7 +224,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::RWops to move data from
/// \param[in] other SDL2pp::RWops to move data from
///
////////////////////////////////////////////////////////////
RWops(RWops&& other) noexcept;
@ -232,7 +232,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment operator
///
/// \param other SDL2pp::RWops to move data from
/// \param[in] other SDL2pp::RWops to move data from
///
/// \returns Reference to self
///
@ -258,7 +258,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create RWops from CustomRWops derived class
///
/// \param custom_rwops Custom %RWops functions
/// \param[in] custom_rwops Custom %RWops functions
///
/// \throws SDL2pp::Exception
///
@ -312,9 +312,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Read from a data stream
///
/// \param ptr Pointer to a buffer to read data into
/// \param size Size of each object to read, in bytes
/// \param maxnum Maximum number of objects to be read
/// \param[in] ptr Pointer to a buffer to read data into
/// \param[in] size Size of each object to read, in bytes
/// \param[in] maxnum Maximum number of objects to be read
///
/// \returns Number of objects read, or 0 at error or end of file
///
@ -326,9 +326,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Seek within the data stream
///
/// \param offset Offset in bytes, relative to whence location; can
/// be negative
/// \param whence Any of RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
/// \param[in] offset Offset in bytes, relative to whence location; can
/// be negative
/// \param[in] whence Any of RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
///
/// \returns Final offset in the data stream after the seek or -1 on error
///
@ -340,9 +340,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Write to a data stream
///
/// \param ptr Pointer to a buffer containing data to write
/// \param size Size of each object to write, in bytes
/// \param num Number of objects to be write
/// \param[in] ptr Pointer to a buffer containing data to write
/// \param[in] size Size of each object to write, in bytes
/// \param[in] num Number of objects to be write
///
/// \returns Number of objects written, which will be less than num on error
///
@ -439,7 +439,7 @@ public:
/// \brief Write 16 bits in native format to a data stream
/// as big-endian data
///
/// \param value Data to be written, in native format
/// \param[in] value Data to be written, in native format
///
/// \returns 1 on successful write, 0 on error
///
@ -452,7 +452,7 @@ public:
/// \brief Write 32 bits in native format to a data stream
/// as big-endian data
///
/// \param value Data to be written, in native format
/// \param[in] value Data to be written, in native format
///
/// \returns 1 on successful write, 0 on error
///
@ -465,7 +465,7 @@ public:
/// \brief Write 64 bits in native format to a data stream
/// as big-endian data
///
/// \param value Data to be written, in native format
/// \param[in] value Data to be written, in native format
///
/// \returns 1 on successful write, 0 on error
///
@ -478,7 +478,7 @@ public:
/// \brief Write 16 bits in native format to a data stream
/// as little-endian data
///
/// \param value Data to be written, in native format
/// \param[in] value Data to be written, in native format
///
/// \returns 1 on successful write, 0 on error
///
@ -491,7 +491,7 @@ public:
/// \brief Write 32 bits in native format to a data stream
/// as little-endian data
///
/// \param value Data to be written, in native format
/// \param[in] value Data to be written, in native format
///
/// \returns 1 on successful write, 0 on error
///
@ -504,7 +504,7 @@ public:
/// \brief Write 64 bits in native format to a data stream
/// as little-endian data
///
/// \param value Data to be written, in native format
/// \param[in] value Data to be written, in native format
///
/// \returns 1 on successful write, 0 on error
///

76
SDL2pp/Rect.hh
View File

@ -60,7 +60,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct a rect from existing SDL_Rect
///
/// \param rect Existing SDL_Rect
/// \param[in] rect Existing SDL_Rect
///
////////////////////////////////////////////////////////////
Rect(const SDL_Rect& rect);
@ -68,8 +68,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct the rect from given corner coordinates, and size
///
/// \param corner Coordinates of the top left rectangle corner
/// \param size Dimensions of the rectangle
/// \param[in] corner Coordinates of the top left rectangle corner
/// \param[in] size Dimensions of the rectangle
///
////////////////////////////////////////////////////////////
Rect(const Point& corner, const Point& size);
@ -77,10 +77,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct the rect from given corner coordinates, width and height
///
/// \param x X coordinate of the top left rectangle corner
/// \param y Y coordinate of the top left rectangle corner
/// \param w Width of the rectangle
/// \param h Height of the rectangle
/// \param[in] x X coordinate of the top left rectangle corner
/// \param[in] y Y coordinate of the top left rectangle corner
/// \param[in] w Width of the rectangle
/// \param[in] h Height of the rectangle
///
////////////////////////////////////////////////////////////
Rect(int x, int y, int w, int h);
@ -88,10 +88,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct the rect from given center coordinates, width and height
///
/// \param cx X coordinate of the rectangle center
/// \param cy Y coordinate of the rectangle center
/// \param w Width of the rectangle
/// \param h Height of the rectangle
/// \param[in] cx X coordinate of the rectangle center
/// \param[in] cy Y coordinate of the rectangle center
/// \param[in] w Width of the rectangle
/// \param[in] h Height of the rectangle
///
////////////////////////////////////////////////////////////
static Rect FromCenter(int cx, int cy, int w, int h);
@ -99,8 +99,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct the rect from given center coordinates and size
///
/// \param center Coordinates of the rectangle center
/// \param size Dimensions of the rectangle
/// \param[in] center Coordinates of the rectangle center
/// \param[in] size Dimensions of the rectangle
///
////////////////////////////////////////////////////////////
static Rect FromCenter(const Point& center, const Point& size);
@ -108,10 +108,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct the rect from given corners coordinates
///
/// \param x1 X coordinate of the top left rectangle corner
/// \param y1 Y coordinate of the top left rectangle corner
/// \param x2 X coordinate of the bottom right rectangle corner
/// \param y2 Y coordinate of the bottom right rectangle corner
/// \param[in] x1 X coordinate of the top left rectangle corner
/// \param[in] y1 Y coordinate of the top left rectangle corner
/// \param[in] x2 X coordinate of the bottom right rectangle corner
/// \param[in] y2 Y coordinate of the bottom right rectangle corner
///
////////////////////////////////////////////////////////////
static Rect FromCorners(int x1, int y1, int x2, int y2);
@ -119,8 +119,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct the rect from given centers coordinates
///
/// \param p1 Coordinates of the top left rectangle corner
/// \param p2 Coordinates of the bottom right rectangle corner
/// \param[in] p1 Coordinates of the top left rectangle corner
/// \param[in] p2 Coordinates of the bottom right rectangle corner
///
////////////////////////////////////////////////////////////
static Rect FromCorners(const Point& p1, const Point& p2);
@ -156,7 +156,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Equality operator
///
/// \param other Rect to compare to
/// \param[in] other Rect to compare to
///
/// \returns True if two rectangles are identical
///
@ -166,7 +166,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Inequality operator
///
/// \param other Rect to compare to
/// \param[in] other Rect to compare to
///
/// \returns True if two rectangles are not identical
///
@ -184,7 +184,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set X coordinate of the rect corner
///
/// \param nx New X coordinate value
/// \param[in] nx New X coordinate value
///
////////////////////////////////////////////////////////////
void SetX(int nx);
@ -200,7 +200,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set Y coordinate of the rect corner
///
/// \param ny New Y coordinate value
/// \param[in] ny New Y coordinate value
///
////////////////////////////////////////////////////////////
void SetY(int ny);
@ -216,7 +216,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set width of the rect
///
/// \param nw New width of the rect
/// \param[in] nw New width of the rect
///
////////////////////////////////////////////////////////////
void SetW(int nw);
@ -232,7 +232,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set height of the rect
///
/// \param nh New height of the rect
/// \param[in] nh New height of the rect
///
////////////////////////////////////////////////////////////
void SetH(int nh);
@ -248,7 +248,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set X coordinate of the rect second corner
///
/// \param x2 New X coordinate value
/// \param[in] x2 New X coordinate value
///
////////////////////////////////////////////////////////////
void SetX2(int x2);
@ -266,7 +266,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set Y coordinate of the rect second corner
///
/// \param y2 New Y coordinate value
/// \param[in] y2 New Y coordinate value
///
/// This modifies rectangle height internally
///
@ -276,8 +276,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Check whether the rect contains given point
///
/// \param x X coordinate of a point
/// \param y Y coordinate of a point
/// \param[in] x X coordinate of a point
/// \param[in] y Y coordinate of a point
///
/// \returns True if the point is contained in the rect
///
@ -287,7 +287,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Check whether the rect contains given point
///
/// \param point Point to check
/// \param[in] point Point to check
///
/// \returns True if the point is contained in the rect
///
@ -297,7 +297,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Check whether the rect contains another rect
///
/// \param rect Rect to check
/// \param[in] rect Rect to check
///
/// \returns True if the checked rect is contained in this rect
///
@ -307,7 +307,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Check whether the rect intersects another rect
///
/// \param rect Rect to check
/// \param[in] rect Rect to check
///
/// \returns True if rectangles intersect
///
@ -317,7 +317,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Calculate union with another rect
///
/// \param rect Rect to union with
/// \param[in] rect Rect to union with
///
/// \returns Rect representing union of two rectangles
///
@ -327,7 +327,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Calculate intersection with another rect
///
/// \param rect Rect to intersect with
/// \param[in] rect Rect to intersect with
///
/// \returns Rect representing intersection area or NullOpt if there was no intersection
///
@ -337,7 +337,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get rectangle moved by a given offset
///
/// \param offset Point specifying an offset
/// \param[in] offset Point specifying an offset
///
/// \returns Moved rectangle
///
@ -347,7 +347,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get rectangle moved by an opposite of given offset
///
/// \param offset Point specifying an offset
/// \param[in] offset Point specifying an offset
///
/// \returns Moved rectangle
///
@ -357,7 +357,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move by then given offset
///
/// \param offset Point specifying an offset
/// \param[in] offset Point specifying an offset
///
/// \returns Reference to self
///
@ -367,7 +367,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move by an opposite of the given offset
///
/// \param offset Point specifying an offset
/// \param[in] offset Point specifying an offset
///
/// \returns Reference to self
///

162
SDL2pp/Renderer.hh
View File

@ -55,7 +55,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct from existing SDL_Renderer structure
///
/// \param renderer Existing SDL_Renderer to manage
/// \param[in] renderer Existing SDL_Renderer to manage
///
////////////////////////////////////////////////////////////
Renderer(SDL_Renderer* renderer);
@ -63,11 +63,11 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create renderer
///
/// \param window Window where rendering is displayed
/// \param index Index of the rendering driver to initialize,
/// or -1 to initialize the first one supporting
/// the requested flags
/// \param flags 0 or more SDL_RendererFlags OR'ed together
/// \param[in] window Window where rendering is displayed
/// \param[in] index Index of the rendering driver to initialize,
/// or -1 to initialize the first one supporting
/// the requested flags
/// \param[in] flags 0 or more SDL_RendererFlags OR'ed together
///
/// \throws SDL2pp::Exception
///
@ -87,7 +87,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::Renderer object to move data from
/// \param[in] other SDL2pp::Renderer object to move data from
///
////////////////////////////////////////////////////////////
Renderer(Renderer&& other) noexcept;
@ -95,7 +95,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment operator
///
/// \param other SDL2pp::Renderer object to move data from
/// \param[in] other SDL2pp::Renderer object to move data from
///
/// \returns Reference to self
///
@ -159,8 +159,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get information about a rendering context
///
/// \param info SDL_RendererInfo structure to be filled with
/// information about the current renderer
/// \param[out] info SDL_RendererInfo structure to be filled with
/// information about the current renderer
///
/// \throws SDL2pp::Exception
///
@ -172,8 +172,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get information about a rendering context
///
/// \param info SDL_RendererInfo structure to be filled with
/// information about the current renderer
/// \param[out] info SDL_RendererInfo structure to be filled with
/// information about the current renderer
///
/// \throws SDL2pp::Exception
///
@ -186,10 +186,10 @@ public:
/// \brief Copy a portion of the texture to the current rendering
/// target
///
/// \param texture Source texture
/// \param srcrect Source rectangle, NullOpt for the entire texture
/// \param dstrect Destination rectangle, NullOpt for the entire
/// rendering target
/// \param[in] texture Source texture
/// \param[in] srcrect Source rectangle, NullOpt for the entire texture
/// \param[in] dstrect Destination rectangle, NullOpt for the entire
/// rendering target
///
/// \throws SDL2pp::Exception
///
@ -202,17 +202,17 @@ public:
/// \brief Copy a portion of the texture to the current rendering
/// target with optional rotating or flipping
///
/// \param texture Source texture
/// \param srcrect Source rectangle, NullOpt for the entire texture
/// \param dstrect Destination rectangle, NullOpt for the entire
/// rendering target
/// \param angle Angle in degrees that indicates the rotation that
/// will be applied to dstrect
/// \param center Point indicating the point around which dstrect
/// will be rotated (NullOpt to rotate around dstrect
/// center)
/// \param flip SDL_RendererFlip value stating which flipping
/// actions should be performed on the texture
/// \param[in] texture Source texture
/// \param[in] srcrect Source rectangle, NullOpt for the entire texture
/// \param[in] dstrect Destination rectangle, NullOpt for the entire
/// rendering target
/// \param[in] angle Angle in degrees that indicates the rotation that
/// will be applied to dstrect
/// \param[in] center Point indicating the point around which dstrect
/// will be rotated (NullOpt to rotate around dstrect
/// center)
/// \param[in] flip SDL_RendererFlip value stating which flipping
/// actions should be performed on the texture
///
/// \throws SDL2pp::Exception
///
@ -225,10 +225,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set color user for drawing operations
///
/// \param r Red value used to draw on the rendering target
/// \param g Green value used to draw on the rendering target
/// \param b Blue value used to draw on the rendering target
/// \param a Alpha value used to draw on the rendering target
/// \param[in] r Red value used to draw on the rendering target
/// \param[in] g Green value used to draw on the rendering target
/// \param[in] b Blue value used to draw on the rendering target
/// \param[in] a Alpha value used to draw on the rendering target
///
/// \throws SDL2pp::Exception
///
@ -250,8 +250,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set current render target to specified texture
///
/// \param texture Target texture, SDL2pp::Texture created with
/// SDL_TEXTUREACCESS_TARGET
/// \param[in] texture Target texture, SDL2pp::Texture created with
/// SDL_TEXTUREACCESS_TARGET
///
/// \throws SDL2pp::Exception
///
@ -263,7 +263,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the blend mode used for drawing operations
///
/// \param blendMode SDL_BlendMode to use for blending
/// \param[in] blendMode SDL_BlendMode to use for blending
///
/// \throws SDL2pp::Exception
///
@ -276,8 +276,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw a point on the current rendering target
///
/// \param x X coordinate of the point
/// \param y Y coordinate of the point
/// \param[in] x X coordinate of the point
/// \param[in] y Y coordinate of the point
///
/// \throws SDL2pp::Exception
///
@ -289,7 +289,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw a point on the current rendering target
///
/// \param p Coordinates of the point
/// \param[in] p Coordinates of the point
///
/// \throws SDL2pp::Exception
///
@ -301,8 +301,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw multiple points on the current rendering target
///
/// \param points Array of coordinates of points to draw
/// \param count Number of points to draw
/// \param[in] points Array of coordinates of points to draw
/// \param[in] count Number of points to draw
///
/// \throws SDL2pp::Exception
///
@ -314,10 +314,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw a line on the current rendering target
///
/// \param x1 X coordinate of the start point
/// \param y1 Y coordinate of the start point
/// \param x2 X coordinate of the end point
/// \param y2 Y coordinate of the end point
/// \param[in] x1 X coordinate of the start point
/// \param[in] y1 Y coordinate of the start point
/// \param[in] x2 X coordinate of the end point
/// \param[in] y2 Y coordinate of the end point
///
/// \throws SDL2pp::Exception
///
@ -329,8 +329,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw a line on the current rendering target
///
/// \param p1 Coordinates of the start point
/// \param p2 Coordinates of the end point
/// \param[in] p1 Coordinates of the start point
/// \param[in] p2 Coordinates of the end point
///
/// \throws SDL2pp::Exception
///
@ -342,8 +342,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw a polyline on the current rendering target
///
/// \param points Array of coordinates of points along the polyline
/// \param count Number of points to draw count-1 polyline segments
/// \param[in] points Array of coordinates of points along the polyline
/// \param[in] count Number of points to draw count-1 polyline segments
///
/// \throws SDL2pp::Exception
///
@ -355,10 +355,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw a rectangle on the current rendering target
///
/// \param x1 X coordinate of the start corner
/// \param y1 Y coordinate of the start corner
/// \param x2 X coordinate of the end corner
/// \param y2 Y coordinate of the end corner
/// \param[in] x1 X coordinate of the start corner
/// \param[in] y1 Y coordinate of the start corner
/// \param[in] x2 X coordinate of the end corner
/// \param[in] y2 Y coordinate of the end corner
///
/// \throws SDL2pp::Exception
///
@ -370,8 +370,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw a rectangle on the current rendering target
///
/// \param p1 Coordinates of the start corner
/// \param p2 Coordinates of the end corner
/// \param[in] p1 Coordinates of the start corner
/// \param[in] p2 Coordinates of the end corner
///
/// \throws SDL2pp::Exception
///
@ -383,7 +383,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw a rectangle on the current rendering target
///
/// \param r Rectangle to draw
/// \param[in] r Rectangle to draw
///
/// \throws SDL2pp::Exception
///
@ -395,8 +395,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Draw multiple rectangles on the current rendering target
///
/// \param rects Array of rectangles to draw
/// \param count Number of rectangles
/// \param[in] rects Array of rectangles to draw
/// \param[in] count Number of rectangles
///
/// \throws SDL2pp::Exception
///
@ -408,10 +408,10 @@ public:
////////////////////////////////////////////////////////////
/// \brief Fill a rectangle on the current rendering target
///
/// \param x1 X coordinate of the start corner
/// \param y1 Y coordinate of the start corner
/// \param x2 X coordinate of the end corner
/// \param y2 Y coordinate of the end corner
/// \param[in] x1 X coordinate of the start corner
/// \param[in] y1 Y coordinate of the start corner
/// \param[in] x2 X coordinate of the end corner
/// \param[in] y2 Y coordinate of the end corner
///
/// \throws SDL2pp::Exception
///
@ -423,8 +423,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Fill a rectangle on the current rendering target
///
/// \param p1 Coordinates of the start corner
/// \param p2 Coordinates of the end corner
/// \param[in] p1 Coordinates of the start corner
/// \param[in] p2 Coordinates of the end corner
///
/// \throws SDL2pp::Exception
///
@ -436,7 +436,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Fill a rectangle on the current rendering target
///
/// \param r Rectangle to draw
/// \param[in] r Rectangle to draw
///
/// \throws SDL2pp::Exception
///
@ -448,8 +448,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Fill multiple rectangles on the current rendering target
///
/// \param rects Array of rectangles to draw
/// \param count Number of rectangles
/// \param[in] rects Array of rectangles to draw
/// \param[in] count Number of rectangles
///
/// \throws SDL2pp::Exception
///
@ -461,14 +461,14 @@ public:
////////////////////////////////////////////////////////////
/// \brief Read pixels from the current rendering target
///
/// \param rect Area to read or NullOpt for the entire render
/// target
/// \param format Desired format of the pixel data, or 0 to
/// use the format of the rendering target
/// \param pixels Pointer to memory to be filled with pixel
/// data
/// \param pitch Number of bytes in a row of pixel data, including
/// padding between lines
/// \param[in] rect Area to read or NullOpt for the entire render
/// target
/// \param[in] format Desired format of the pixel data, or 0 to
/// use the format of the rendering target
/// \param[in] pixels Pointer to memory to be filled with pixel
/// data
/// \param[in] pitch Number of bytes in a row of pixel data, including
/// padding between lines
///
/// \throws SDL2pp::Exception
///
@ -480,8 +480,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the clipping rectangle for rendering
///
/// \param rect New clipping rectangle or NullOpt to disable
/// clipping
/// \param[in] rect New clipping rectangle or NullOpt to disable
/// clipping
///
/// \throws SDL2pp::Exception
///
@ -493,8 +493,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set a device independent resolution for rendering
///
/// \param w Width of the logical resolution
/// \param h Height of the logical resolution
/// \param[in] w Width of the logical resolution
/// \param[in] h Height of the logical resolution
///
/// \throws SDL2pp::Exception
///
@ -506,8 +506,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the drawing scale for rendering on the current target
///
/// \param scaleX Horizontal scaling factor
/// \param scaleY Vertical scaling factor
/// \param[in] scaleX Horizontal scaling factor
/// \param[in] scaleY Vertical scaling factor
///
/// \throws SDL2pp::Exception
///
@ -519,8 +519,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the drawing area for rendering on the current target
///
/// \param rect Rectangle representing the drawing area or
/// NullOpt to set the viewport to the entire target
/// \param[in] rect Rectangle representing the drawing area or
/// NullOpt to set the viewport to the entire target
///
/// \throws SDL2pp::Exception
///

16
SDL2pp/SDL.hh
View File

@ -58,7 +58,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Initializes SDL2 library
///
/// \param flags Flags to pass to SDL_Init()
/// \param[in] flags Flags to pass to SDL_Init()
///
/// \throws SDL2pp::Exception
///
@ -110,9 +110,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Checks which SDL2 subsystems were initialized
///
/// \param flags 0 to return mask of initialized subsystems
/// or any combination of flags to return initialization
/// status of the specified subsystems
/// \param[in] flags 0 to return mask of initialized subsystems
/// or any combination of flags to return initialization
/// status of the specified subsystems
///
/// \returns Mask of initialized subsystems or the initialization
/// status of the specified subsystems
@ -125,8 +125,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Initializes additional SDL2 subsystems
///
/// \param flags Set of flags which determines which subsystems
/// to initialize
/// \param[in] flags Set of flags which determines which subsystems
/// to initialize
///
/// \throws SDL2pp::Exception
///
@ -138,8 +138,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Deinitializes specific SDL2 subsystems
///
/// \param flags Set of flags which determines which subsystems
/// to deinitialize
/// \param[in] flags Set of flags which determines which subsystems
/// to deinitialize
///
/// \see http://wiki.libsdl.org/SDL_QuitSubSystem
///

4
SDL2pp/SDLImage.hh
View File

@ -57,7 +57,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Initializes SDL_image library
///
/// \param flags Flags to pass to IMG_Init()
/// \param[in] flags Flags to pass to IMG_Init()
///
/// \throws SDL2pp::Exception
///
@ -77,7 +77,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Try to init more SDL_image formats
///
/// \param flags Flags to pass to IMG_Init()
/// \param[in] flags Flags to pass to IMG_Init()
///
/// \throws SDL2pp::Exception
///

20
SDL2pp/StreamRWops.hh
View File

@ -135,7 +135,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct StreamRWops for specified stream
///
/// \param stream Stream to use
/// \param[in] stream Stream to use
///
////////////////////////////////////////////////////////////
StreamRWops(S& stream) : stream_(stream) {
@ -144,9 +144,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Seek within the stream
///
/// \param offset Offset in bytes, relative to whence location; can
/// be negative
/// \param whence Any of RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
/// \param[in] offset Offset in bytes, relative to whence location; can
/// be negative
/// \param[in] whence Any of RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
///
/// \returns Final offset in the stream after the seek or -1 on error
///
@ -174,9 +174,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Read from a stream
///
/// \param ptr Pointer to a buffer to read data into
/// \param size Size of each object to read, in bytes
/// \param maxnum Maximum number of objects to be read
/// \param[in] ptr Pointer to a buffer to read data into
/// \param[in] size Size of each object to read, in bytes
/// \param[in] maxnum Maximum number of objects to be read
///
/// \returns Number of objects read, or 0 at error or end of file
///
@ -191,9 +191,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Write to a stream
///
/// \param ptr Pointer to a buffer containing data to write
/// \param size Size of each object to write, in bytes
/// \param num Number of objects to be write
/// \param[in] ptr Pointer to a buffer containing data to write
/// \param[in] size Size of each object to write, in bytes
/// \param[in] num Number of objects to be write
///
/// \returns Number of objects written
///

98
SDL2pp/Surface.hh
View File

@ -104,7 +104,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::Surface::LockHandle to move data from
/// \param[in] other SDL2pp::Surface::LockHandle to move data from
///
////////////////////////////////////////////////////////////
LockHandle(LockHandle&& other) noexcept;
@ -112,7 +112,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment operator
///
/// \param other SDL2pp::Surface::LockHandle to move data from
/// \param[in] other SDL2pp::Surface::LockHandle to move data from
///
/// \returns Reference to self
///
@ -165,7 +165,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct from existing SDL_Surface structure
///
/// \param surface Existing SDL_Surface to manage
/// \param[in] surface Existing SDL_Surface to manage
///
////////////////////////////////////////////////////////////
Surface(SDL_Surface* surface);
@ -173,14 +173,14 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create RGB surface
///
/// \param flags Unused and should be set to 0
/// \param width Width of the surface
/// \param height Height of the surface
/// \param depth Depth of the surface in bits
/// \param Rmask Red mask for the pixels
/// \param Gmask Green mask for the pixels
/// \param Bmask Blue mask for the pixels
/// \param Amask Alpha mask for the pixels
/// \param[in] flags Unused and should be set to 0
/// \param[in] width Width of the surface
/// \param[in] height Height of the surface
/// \param[in] depth Depth of the surface in bits
/// \param[in] Rmask Red mask for the pixels
/// \param[in] Gmask Green mask for the pixels
/// \param[in] Bmask Blue mask for the pixels
/// \param[in] Amask Alpha mask for the pixels
///
/// \throws SDL2pp::Exception
///
@ -192,15 +192,15 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create RGB surface with existing pixel data
///
/// \param pixels Pointer to existing pixel data
/// \param width Width of the surface
/// \param height Height of the surface
/// \param depth Depth of the surface in bits
/// \param pitch Number of bytes in a row of pixel data, including padding between lines
/// \param Rmask Red mask for the pixels
/// \param Gmask Green mask for the pixels
/// \param Bmask Blue mask for the pixels
/// \param Amask Alpha mask for the pixels
/// \param[in] pixels Pointer to existing pixel data
/// \param[in] width Width of the surface
/// \param[in] height Height of the surface
/// \param[in] depth Depth of the surface in bits
/// \param[in] pitch Number of bytes in a row of pixel data, including padding between lines
/// \param[in] Rmask Red mask for the pixels
/// \param[in] Gmask Green mask for the pixels
/// \param[in] Bmask Blue mask for the pixels
/// \param[in] Amask Alpha mask for the pixels
///
/// \throws SDL2pp::Exception
///
@ -213,7 +213,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create surface loading it via RWops
///
/// \param rwops RWops used to access an image file
/// \param[in] rwops RWops used to access an image file
///
////////////////////////////////////////////////////////////
Surface(RWops& rwops);
@ -221,7 +221,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create surface loading it from file
///
/// \param filename Path to an image file
/// \param[in] filename Path to an image file
///
////////////////////////////////////////////////////////////
Surface(const std::string& filename);
@ -238,7 +238,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::Surface object to move data from
/// \param[in] other SDL2pp::Surface object to move data from
///
////////////////////////////////////////////////////////////
Surface(Surface&& other) noexcept;
@ -246,7 +246,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment
///
/// \param other SDL2pp::Surface object to move data from
/// \param[in] other SDL2pp::Surface object to move data from
///
/// \returns Reference to self
///
@ -281,7 +281,7 @@ public:
/// \brief Copy an existing surface into a new one that is
/// optimized for blitting to a surface of a specified pixel format
///
/// \param format SDL_PixelFormat structure that the new surface is optimized for
/// \param[in] format SDL_PixelFormat structure that the new surface is optimized for
///
/// \throws SDL2pp::Exception
///
@ -293,7 +293,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Copy an existing surface to a new surface of the specified format
///
/// \param pixel_format One of the enumerated values in SDL_PixelFormatEnum
/// \param[in] pixel_format One of the enumerated values in SDL_PixelFormatEnum
///
/// \throws SDL2pp::Exception
///
@ -306,9 +306,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Fast surface copy to a destination surface
///
/// \param srcrect Rectangle to be copied, or NullOpt to copy the entire surface
/// \param dst Blit target surface
/// \param dstrect Rectangle that is copied into
/// \param[in] srcrect Rectangle to be copied, or NullOpt to copy the entire surface
/// \param[in] dst Blit target surface
/// \param[in] dstrect Rectangle that is copied into
///
/// \throws SDL2pp::Exception
///
@ -320,9 +320,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Scaled surface copy to a destination surface
///
/// \param srcrect Rectangle to be copied, or NullOpt to copy the entire surface
/// \param dst Blit target surface
/// \param dstrect Rectangle that is copied into, or NullOpt to copy into entire surface
/// \param[in] srcrect Rectangle to be copied, or NullOpt to copy the entire surface
/// \param[in] dst Blit target surface
/// \param[in] dstrect Rectangle that is copied into, or NullOpt to copy into entire surface
///
/// \throws SDL2pp::Exception
///
@ -392,9 +392,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Get the additional color value multiplied into blit operations
///
/// \param r Variable to be filled in with the current red color value
/// \param g Variable to be filled in with the current green color value
/// \param b Variable to be filled in with the current blue color value
/// \param[out] r Variable to be filled in with the current red color value
/// \param[out] g Variable to be filled in with the current green color value
/// \param[out] b Variable to be filled in with the current blue color value
///
/// \throws SDL2pp::Exception
///
@ -406,7 +406,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the clipping rectangle for a surface
///
/// \param rect Rect representing the clipping rectangle, or NullOpt to disable clipping
/// \param[in] rect Rect representing the clipping rectangle, or NullOpt to disable clipping
///
/// \throws SDL2pp::Exception
///
@ -418,8 +418,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the color key (transparent pixel) in a surface
///
/// \param flag True to enabled color key, false to disable
/// \param key Transparent pixel value
/// \param[in] flag True to enabled color key, false to disable
/// \param[in] key Transparent pixel value
///
/// \throws SDL2pp::Exception
///
@ -431,7 +431,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set an additional alpha value used in blit operations
///
/// \param alpha Alpha value multiplied into blit operations
/// \param[in] alpha Alpha value multiplied into blit operations
///
/// \throws SDL2pp::Exception
///
@ -443,7 +443,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the blend mode used for blit operations
///
/// \param blendMode SDL_BlendMode to use for blit blending
/// \param[in] blendMode SDL_BlendMode to use for blit blending
///
/// \throws SDL2pp::Exception
///
@ -455,9 +455,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set an additional color value multiplied into blit operations
///
/// \param r Red color value multiplied into blit operations
/// \param g Green color value multiplied into blit operations
/// \param b Blue color value multiplied into blit operations
/// \param[in] r Red color value multiplied into blit operations
/// \param[in] g Green color value multiplied into blit operations
/// \param[in] b Blue color value multiplied into blit operations
///
/// \throws SDL2pp::Exception
///
@ -469,7 +469,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the RLE acceleration hint for a surface
///
/// \param flag False to disable, true to enable RLE acceleration
/// \param[in] flag False to disable, true to enable RLE acceleration
///
/// \throws SDL2pp::Exception
///
@ -481,8 +481,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Perform a fast fill of a rectangle with a specific color
///
/// \param rect Rectangle to fill, or NullOpt to fill the entire surface
/// \param color Color to fill with
/// \param[in] rect Rectangle to fill, or NullOpt to fill the entire surface
/// \param[in] color Color to fill with
///
/// \throws SDL2pp::Exception
///
@ -494,9 +494,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Perform a fast fill of a set of rectangles with a specific color
///
/// \param rects Array rectangles to be filled
/// \param count Number of rectangles in the array
/// \param color Color to fill with
/// \param[in] rects Array rectangles to be filled
/// \param[in] count Number of rectangles in the array
/// \param[in] color Color to fill with
///
/// \throws SDL2pp::Exception
///

58
SDL2pp/Texture.hh
View File

@ -102,7 +102,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create lock for specific SDL2pp::Texture
///
/// \param rect Specifies region to lock
/// \param[in] rect Specifies region to lock
///
/// \throws STL2pp::Exception
///
@ -134,7 +134,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::Texture::LockHandle to move data from
/// \param[in] other SDL2pp::Texture::LockHandle to move data from
///
////////////////////////////////////////////////////////////
LockHandle(LockHandle&& other) noexcept;
@ -142,7 +142,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment operator
///
/// \param other SDL2pp::Texture::LockHandle to move data from
/// \param[in] other SDL2pp::Texture::LockHandle to move data from
///
/// \returns Reference to self
///
@ -187,7 +187,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct from existing SDL_Texture structure
///
/// \param texture Existing SDL_Texture to manage
/// \param[in] texture Existing SDL_Texture to manage
///
////////////////////////////////////////////////////////////
Texture(SDL_Texture* texture);
@ -195,11 +195,11 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create empty texture
///
/// \param renderer Rendering context to create texture for
/// \param format One of the enumerated values in SDL_PixelFormatEnum
/// \param access One of the enumerated values in SDL_TextureAccess
/// \param w Width of the texture in pixels
/// \param h Height of the texture in pixels
/// \param[in] renderer Rendering context to create texture for
/// \param[in] format One of the enumerated values in SDL_PixelFormatEnum
/// \param[in] access One of the enumerated values in SDL_TextureAccess
/// \param[in] w Width of the texture in pixels
/// \param[in] h Height of the texture in pixels
///
/// \throws SDL2pp::Exception
///
@ -212,8 +212,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create texture loading it via RWops
///
/// \param renderer Rendering context to create texture for
/// \param rwops RWops used to access an image file
/// \param[in] renderer Rendering context to create texture for
/// \param[in] rwops RWops used to access an image file
///
/// \throws SDL2pp::Exception
///
@ -223,8 +223,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create texture loading it from file
///
/// \param renderer Rendering context to create texture for
/// \param filename Path to an image file
/// \param[in] renderer Rendering context to create texture for
/// \param[in] filename Path to an image file
///
/// \throws SDL2pp::Exception
///
@ -235,8 +235,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create texture from surface
///
/// \param renderer Rendering context to create texture for
/// \param surface Surface containing pixel data used to fill the texture
/// \param[in] renderer Rendering context to create texture for
/// \param[in] surface Surface containing pixel data used to fill the texture
///
/// \throws SDL2pp::Exception
///
@ -256,7 +256,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::Texture object to move data from
/// \param[in] other SDL2pp::Texture object to move data from
///
////////////////////////////////////////////////////////////
Texture(Texture&& other) noexcept;
@ -264,7 +264,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment
///
/// \param other SDL2pp::Texture object to move data from
/// \param[in] other SDL2pp::Texture object to move data from
///
/// \returns Reference to self
///
@ -298,11 +298,11 @@ public:
////////////////////////////////////////////////////////////
/// \brief Update the given texture rectangle with new pixel data
///
/// \param rect Rect representing the area to update, or NullOpt to
/// update the entire texture
/// \param pixels Raw pixel data
/// \param pitch Number of bytes in a row of pixel data, including
/// padding between lines
/// \param[in] rect Rect representing the area to update, or NullOpt to
/// update the entire texture
/// \param[in] pixels Raw pixel data
/// \param[in] pitch Number of bytes in a row of pixel data, including
/// padding between lines
///
/// \throws SDL2pp::Exception
///
@ -314,7 +314,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the blend mode for a texture, used by SDL2pp::Renderer::Copy
///
/// \param blendMode SDL_BlendMode to use for texture blending
/// \param[in] blendMode SDL_BlendMode to use for texture blending
///
/// \throws SDL2pp::Exception
///
@ -326,7 +326,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set an additional alpha value multiplied into render copy operations
///
/// \param alpha Source alpha value multiplied into copy operations
/// \param[in] alpha Source alpha value multiplied into copy operations
///
/// \throws SDL2pp::Exception
///
@ -338,9 +338,9 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set an additional color value multiplied into render copy operations
///
/// \param r Red color value multiplied into copy operations
/// \param g Green color value multiplied into copy operations
/// \param b Blue color value multiplied into copy operations
/// \param[in] r Red color value multiplied into copy operations
/// \param[in] g Green color value multiplied into copy operations
/// \param[in] b Blue color value multiplied into copy operations
///
/// \throws SDL2pp::Exception
///
@ -352,8 +352,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Lock texture for write-only pixel access
///
/// \param rect Rect representing area to lock for access
/// (NullOpt to lock entire texture)
/// \param[in] rect Rect representing area to lock for access
/// (NullOpt to lock entire texture)
///
/// \return Lock handle used to access pixel data and to control lock lifetime
///

8
SDL2pp/Wav.hh
View File

@ -59,7 +59,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Load audio from file on disk
///
/// \param file Path to the wav file
/// \param[in] file Path to the wav file
///
/// \throws SDL2pp::Exception
///
@ -71,7 +71,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Load audio using RWops
///
/// \param rwops SDL2pp::RWops used to access wav data
/// \param[in] rwops SDL2pp::RWops used to access wav data
///
/// \throws SDL2pp::Exception
///
@ -89,7 +89,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::Wav object to move data from
/// \param[in] other SDL2pp::Wav object to move data from
///
////////////////////////////////////////////////////////////
Wav(Wav&& other);
@ -97,7 +97,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment operator
///
/// \param other SDL2pp::Wav object to move data from
/// \param[in] other SDL2pp::Wav object to move data from
///
/// \returns Reference to self
///

28
SDL2pp/Window.hh
View File

@ -67,7 +67,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Construct from existing SDL_Window structure
///
/// \param window Existing SDL_Window to manage
/// \param[in] window Existing SDL_Window to manage
///
////////////////////////////////////////////////////////////
Window(SDL_Window* window);
@ -75,12 +75,12 @@ public:
////////////////////////////////////////////////////////////
/// \brief Create window with specified title and dimensions
///
/// \param title Title of the windows, in UTF-8 encoding
/// \param x X position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
/// \param y X position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
/// \param w Width of the window
/// \param h Height of the window
/// \param flags 0 or more SDL_WindowFlags OR'd together
/// \param[in] title Title of the windows, in UTF-8 encoding
/// \param[in] x X position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
/// \param[in] y X position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
/// \param[in] w Width of the window
/// \param[in] h Height of the window
/// \param[in] flags 0 or more SDL_WindowFlags OR'd together
///
/// \throws SDL2pp::Exception
///
@ -100,7 +100,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move constructor
///
/// \param other SDL2pp::Window object to move data from
/// \param[in] other SDL2pp::Window object to move data from
///
////////////////////////////////////////////////////////////
Window(Window&& other) noexcept;
@ -108,7 +108,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Move assignment operator
///
/// \param other SDL2pp::Window object to move data from
/// \param[in] other SDL2pp::Window object to move data from
///
/// \returns Reference to self
///
@ -173,7 +173,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set window title
///
/// \param title New window title in UTF-8 encoding
/// \param[in] title New window title in UTF-8 encoding
///
/// \see http://wiki.libsdl.org/SDL_SetWindowTitle
///
@ -231,7 +231,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set a window's fullscreen state
///
/// \param flags SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP or 0
/// \param[in] flags SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP or 0
///
/// \throws SDL2pp::Exception
///
@ -243,8 +243,8 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the size of a window's client area
///
/// \param w Width of the window in pixels
/// \param h Height of the window in pixels
/// \param[in] w Width of the window in pixels
/// \param[in] h Height of the window in pixels
///
/// \see http://wiki.libsdl.org/SDL_SetWindowSize
///
@ -254,7 +254,7 @@ public:
////////////////////////////////////////////////////////////
/// \brief Set the size of a window's client area
///
/// \param size Point representing window dimensions
/// \param[in] size Point representing window dimensions
///
/// \see http://wiki.libsdl.org/SDL_SetWindowSize
///