From 799ca304ce253b86711a4e4918124aa15ea89700 Mon Sep 17 00:00:00 2001 From: kimci86 Date: Fri, 8 Nov 2024 23:32:20 +0100 Subject: [PATCH] Format index argument as code in shapes getPoint/setPoint documentation We do the same in sf::Text::findCharacterPos documentation already. --- include/SFML/Graphics/CircleShape.hpp | 2 +- include/SFML/Graphics/ConvexShape.hpp | 2 +- include/SFML/Graphics/RectangleShape.hpp | 2 +- include/SFML/Graphics/Shape.hpp | 2 +- include/SFML/Graphics/VertexArray.hpp | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/include/SFML/Graphics/CircleShape.hpp b/include/SFML/Graphics/CircleShape.hpp index 62e1dc01e..b05b75530 100644 --- a/include/SFML/Graphics/CircleShape.hpp +++ b/include/SFML/Graphics/CircleShape.hpp @@ -104,7 +104,7 @@ public: /// /// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// - /// \return index-th point of the shape + /// \return `index`-th point of the shape /// //////////////////////////////////////////////////////////// [[nodiscard]] Vector2f getPoint(std::size_t index) const override; diff --git a/include/SFML/Graphics/ConvexShape.hpp b/include/SFML/Graphics/ConvexShape.hpp index feb8473ea..d8406e981 100644 --- a/include/SFML/Graphics/ConvexShape.hpp +++ b/include/SFML/Graphics/ConvexShape.hpp @@ -106,7 +106,7 @@ public: /// /// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// - /// \return Position of the index-th point of the polygon + /// \return Position of the `index`-th point of the polygon /// /// \see `setPoint` /// diff --git a/include/SFML/Graphics/RectangleShape.hpp b/include/SFML/Graphics/RectangleShape.hpp index 846903099..09ef2119b 100644 --- a/include/SFML/Graphics/RectangleShape.hpp +++ b/include/SFML/Graphics/RectangleShape.hpp @@ -92,7 +92,7 @@ public: /// /// \param index Index of the point to get, in range [0 .. 3] /// - /// \return index-th point of the shape + /// \return `index`-th point of the shape /// //////////////////////////////////////////////////////////// [[nodiscard]] Vector2f getPoint(std::size_t index) const override; diff --git a/include/SFML/Graphics/Shape.hpp b/include/SFML/Graphics/Shape.hpp index dc3657ff4..4c00dbd44 100644 --- a/include/SFML/Graphics/Shape.hpp +++ b/include/SFML/Graphics/Shape.hpp @@ -208,7 +208,7 @@ public: /// /// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// - /// \return index-th point of the shape + /// \return `index`-th point of the shape /// /// \see `getPointCount` /// diff --git a/include/SFML/Graphics/VertexArray.hpp b/include/SFML/Graphics/VertexArray.hpp index 6dc472819..9528b1899 100644 --- a/include/SFML/Graphics/VertexArray.hpp +++ b/include/SFML/Graphics/VertexArray.hpp @@ -85,7 +85,7 @@ public: /// /// \param index Index of the vertex to get /// - /// \return Reference to the index-th vertex + /// \return Reference to the `index`-th vertex /// /// \see `getVertexCount` /// @@ -101,7 +101,7 @@ public: /// /// \param index Index of the vertex to get /// - /// \return Const reference to the index-th vertex + /// \return Const reference to the `index`-th vertex /// /// \see `getVertexCount` ///