From 7d11af70058dadd61c2b33474acca4af7ac5b1e9 Mon Sep 17 00:00:00 2001 From: Dmitry Marakasov Date: Fri, 26 Dec 2014 21:41:18 +0300 Subject: [PATCH] Fix case of param/returns descriptions --- SDL2pp/Point.hh | 24 ++++++++++++------------ SDL2pp/RWops.hh | 12 ++++++------ SDL2pp/Rect.hh | 40 ++++++++++++++++++++-------------------- SDL2pp/Renderer.hh | 6 +++--- 4 files changed, 41 insertions(+), 41 deletions(-) diff --git a/SDL2pp/Point.hh b/SDL2pp/Point.hh index b82bb60..0923166 100644 --- a/SDL2pp/Point.hh +++ b/SDL2pp/Point.hh @@ -96,7 +96,7 @@ public: /// /// \param other Point to compare to /// - /// \returns whether two points are identical + /// \returns True if two points are identical /// //////////////////////////////////////////////////////////// bool operator==(const Point& other) const; @@ -106,7 +106,7 @@ public: /// /// \param other Point to compare to /// - /// \returns whether two points are not identical + /// \returns True if two points are not identical /// //////////////////////////////////////////////////////////// bool operator!=(const Point& other) const; @@ -127,7 +127,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Set X coordinate of the point /// - /// \param nx new X coordinate value + /// \param 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 ny New Y coordinate value /// //////////////////////////////////////////////////////////// void SetY(int ny); @@ -151,9 +151,9 @@ public: //////////////////////////////////////////////////////////// /// \brief Get sum of two points /// - /// \param other point to add + /// \param other Point to add /// - /// \returns a new Point representing memberwise addition of two points + /// \returns New Point representing memberwise addition of two points /// //////////////////////////////////////////////////////////// Point operator+(const Point& other) const; @@ -161,9 +161,9 @@ public: //////////////////////////////////////////////////////////// /// \brief Get subtraction of two points /// - /// \param other point to subtract + /// \param other Point to subtract /// - /// \returns a new Point representing memberwise subtraction of two points + /// \returns New Point representing memberwise subtraction of two points /// //////////////////////////////////////////////////////////// Point operator-(const Point& other) const; @@ -171,9 +171,9 @@ public: //////////////////////////////////////////////////////////// /// \brief Add another point /// - /// \param other point to add to the current one + /// \param other Point to add to the current one /// - /// \returns reference to self + /// \returns Reference to self /// //////////////////////////////////////////////////////////// Point& operator+=(const Point& other); @@ -181,9 +181,9 @@ public: //////////////////////////////////////////////////////////// /// \brief Substact another point /// - /// \param other point to subtract from the current one + /// \param other Point to subtract from the current one /// - /// \returns reference to self + /// \returns Reference to self /// //////////////////////////////////////////////////////////// Point& operator-=(const Point& other); diff --git a/SDL2pp/RWops.hh b/SDL2pp/RWops.hh index 8f1c13b..fa285f5 100644 --- a/SDL2pp/RWops.hh +++ b/SDL2pp/RWops.hh @@ -423,7 +423,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 value Data to be written, in native format /// /// \returns 1 on successful write, 0 on error /// @@ -436,7 +436,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 value Data to be written, in native format /// /// \returns 1 on successful write, 0 on error /// @@ -449,7 +449,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 value Data to be written, in native format /// /// \returns 1 on successful write, 0 on error /// @@ -462,7 +462,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 value Data to be written, in native format /// /// \returns 1 on successful write, 0 on error /// @@ -475,7 +475,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 value Data to be written, in native format /// /// \returns 1 on successful write, 0 on error /// @@ -488,7 +488,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 value Data to be written, in native format /// /// \returns 1 on successful write, 0 on error /// diff --git a/SDL2pp/Rect.hh b/SDL2pp/Rect.hh index 21234c5..ed51eb4 100644 --- a/SDL2pp/Rect.hh +++ b/SDL2pp/Rect.hh @@ -61,8 +61,8 @@ public: /// /// \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 w Width of the rectangle + /// \param h Height of the rectangle /// //////////////////////////////////////////////////////////// Rect(int x, int y, int w, int h); @@ -74,8 +74,8 @@ public: /// /// \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 w Width of the rectangle + /// \param h Height of the rectangle /// //////////////////////////////////////////////////////////// static Rect FromCenter(int cx, int cy, int w, int h); @@ -113,7 +113,7 @@ public: /// /// \param other Rect to compare to /// - /// \returns whether two rectangles are identical + /// \returns Whether two rectangles are identical /// //////////////////////////////////////////////////////////// bool operator==(const Rect& other) const; @@ -123,7 +123,7 @@ public: /// /// \param other Rect to compare to /// - /// \returns whether two rectangles are not identical + /// \returns Whether two rectangles are not identical /// //////////////////////////////////////////////////////////// bool operator!=(const Rect& other) const; @@ -144,7 +144,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Set X coordinate of the rect corner /// - /// \param nx new X coordinate value + /// \param nx New X coordinate value /// //////////////////////////////////////////////////////////// void SetX(int nx); @@ -160,7 +160,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Set Y coordinate of the rect corner /// - /// \param ny new Y coordinate value + /// \param ny New Y coordinate value /// //////////////////////////////////////////////////////////// void SetY(int ny); @@ -168,7 +168,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Get width of the rect /// - /// \returns width of the rect + /// \returns Width of the rect /// //////////////////////////////////////////////////////////// int GetW() const; @@ -176,7 +176,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Set width of the rect /// - /// \param nw new width of the rect + /// \param nw New width of the rect /// //////////////////////////////////////////////////////////// void SetW(int nw); @@ -184,7 +184,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Get height of the rect /// - /// \returns height of the rect + /// \returns Height of the rect /// //////////////////////////////////////////////////////////// int GetH() const; @@ -192,7 +192,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Set height of the rect /// - /// \param nh new height of the rect + /// \param nh New height of the rect /// //////////////////////////////////////////////////////////// void SetH(int nh); @@ -208,7 +208,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Set X coordinate of the rect second corner /// - /// \param x2 new X coordinate value + /// \param x2 New X coordinate value /// //////////////////////////////////////////////////////////// void SetX2(int x2); @@ -226,7 +226,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Set Y coordinate of the rect second corner /// - /// \param y2 new Y coordinate value + /// \param y2 New Y coordinate value /// /// This modifies rectangle height internally /// @@ -236,9 +236,9 @@ public: //////////////////////////////////////////////////////////// /// \brief Check whether the rect contains given point /// - /// \param point point to check + /// \param point Point to check /// - /// \returns whether the point is contained in the rect + /// \returns Whether the point is contained in the rect /// //////////////////////////////////////////////////////////// bool Contains(const Point& point) const; @@ -248,7 +248,7 @@ public: /// /// \param offset Point specifying an offset /// - /// \returns moved rectangle + /// \returns Moved rectangle /// //////////////////////////////////////////////////////////// Rect operator+(const Point& offset) const; @@ -258,7 +258,7 @@ public: /// /// \param offset Point specifying an offset /// - /// \returns moved rectangle + /// \returns Moved rectangle /// //////////////////////////////////////////////////////////// Rect operator-(const Point& offset) const; @@ -268,7 +268,7 @@ public: /// /// \param offset Point specifying an offset /// - /// \returns reference to self + /// \returns Reference to self /// //////////////////////////////////////////////////////////// Rect& operator+=(const Point& offset); @@ -278,7 +278,7 @@ public: /// /// \param offset Point specifying an offset /// - /// \returns reference to self + /// \returns Reference to self /// //////////////////////////////////////////////////////////// Rect& operator-=(const Point& offset); diff --git a/SDL2pp/Renderer.hh b/SDL2pp/Renderer.hh index 3e4b6b7..42fa58c 100644 --- a/SDL2pp/Renderer.hh +++ b/SDL2pp/Renderer.hh @@ -405,8 +405,8 @@ public: //////////////////////////////////////////////////////////// /// \brief Set a device independent resolution for rendering /// - /// \param w width of the logical resolution - /// \param h heigth of the logical resolution + /// \param w Width of the logical resolution + /// \param h Heigth of the logical resolution /// /// \see http://wiki.libsdl.org/SDL_RenderSetLogicalSize /// @@ -439,7 +439,7 @@ public: /// \brief Determine whether a window supports the use of /// render targets /// - /// \returns true if render targets are supported + /// \returns True if render targets are supported /// /// \see http://wiki.libsdl.org/SDL_RenderTargetSupported ///