mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-28 14:21:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Format index argument as code in shapes getPoint/setPoint documentation

Browse Source 
We do the same in sf::Text::findCharacterPos documentation already.
This commit is contained in:
kimci86 2024-11-08 23:32:20 +01:00 committed by Chris Thrasher
parent a8b0f6fb70
commit 799ca304ce
5 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/SFML/Graphics/CircleShape.hpp
View File

@ -104,7 +104,7 @@ public:
/// ///
/// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// \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; [[nodiscard]] Vector2f getPoint(std::size_t index) const override;

2
include/SFML/Graphics/ConvexShape.hpp
View File

@ -106,7 +106,7 @@ public:
/// ///
/// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// \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` /// \see `setPoint`
/// ///

2
include/SFML/Graphics/RectangleShape.hpp
View File

@ -92,7 +92,7 @@ public:
/// ///
/// \param index Index of the point to get, in range [0 .. 3] /// \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; [[nodiscard]] Vector2f getPoint(std::size_t index) const override;

2
include/SFML/Graphics/Shape.hpp
View File

@ -208,7 +208,7 @@ public:
/// ///
/// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// \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` /// \see `getPointCount`
/// ///

4
include/SFML/Graphics/VertexArray.hpp
View File

@ -85,7 +85,7 @@ public:
/// ///
/// \param index Index of the vertex to get /// \param index Index of the vertex to get
/// ///
/// \return Reference to the index-th vertex /// \return Reference to the `index`-th vertex
/// ///
/// \see `getVertexCount` /// \see `getVertexCount`
/// ///
@ -101,7 +101,7 @@ public:
/// ///
/// \param index Index of the vertex to get /// \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` /// \see `getVertexCount`
/// ///