From 498304cdf105d4d9abc023f648d198c2ea2d1acf Mon Sep 17 00:00:00 2001 From: Susan Date: Fri, 14 Feb 2025 16:19:51 +0000 Subject: [PATCH] Cleanup: missing @returns --- src/tree_cmd.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/tree_cmd.cpp b/src/tree_cmd.cpp index 8036daa85e..cd5fbd5256 100644 --- a/src/tree_cmd.cpp +++ b/src/tree_cmd.cpp @@ -232,10 +232,11 @@ std::array 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 CreateRandomStarShapedPolygon(const int radius) {