mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

Cleanup: missing @returns

pull/13515/head
Susan 2025-02-14 16:19:51 +00:00
parent 42bd0f6721
commit 498304cdf1
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/tree_cmd.cpp
View File

@ -232,10 +232,11 @@ std::array<Point, GROVE_RESOLUTION> CreateStarShapedPolygon(const int radius, co
static const double PHASE_DIVISOR = INT32_MAX / (M_PI * 2); ///< Valid values for the phase of blob harmonics are between 0 and Tau. we can get a value in the correct range from Random() by dividing the maximum possible value by the desired maximum, and then dividing the random value by the result.
/**
* Creates a random star-shaped[sic] polygon originating from (0, 0).
* Creates a random star-shaped polygon originating from (0, 0).
*
* @param radius The maximum radius of the blob. May be smaller, but will not be larger.
* @param noOfSegments How many segments make up the blob.
* @returns A star-shaped polygon.
*/
std::array<Point, GROVE_RESOLUTION> CreateRandomStarShapedPolygon(const int radius)
{