From 6f0d0ac9862487488bcde0ecf7e688d81ab285fa Mon Sep 17 00:00:00 2001 From: faisalansari0367 <61263149+faisalansari0367@users.noreply.github.com> Date: Fri, 28 Aug 2026 00:08:16 +0530 Subject: [PATCH 1/3] Document the public CircleGenerator API Removes the public_member_api_docs ignore for circle_generator.dart and documents the class and its public createCircle constructor method, per the ongoing vector_math doc migration tracked in flutter/flutter#186827. --- packages/vector_math/CHANGELOG.md | 4 ++++ .../generators/circle_generator.dart | 11 +++++++---- packages/vector_math/pubspec.yaml | 2 +- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/packages/vector_math/CHANGELOG.md b/packages/vector_math/CHANGELOG.md index a232ed01..4ba08dc6 100644 --- a/packages/vector_math/CHANGELOG.md +++ b/packages/vector_math/CHANGELOG.md @@ -1,3 +1,7 @@ +## 2.4.3 + +* Documents the public `CircleGenerator` API. + ## 2.4.2 * Documents the public geometry filter APIs. diff --git a/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart b/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart index 45b46285..08b0bbe0 100644 --- a/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart +++ b/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart @@ -2,12 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -// TODO(stuartmorgan): Remove this and fix violations. See -// https://github.com/flutter/flutter/issues/186827 -// ignore_for_file: public_member_api_docs - part of '../../../vector_math_geometry.dart'; +/// Generates a flat, circular (or partial circle/pie-slice) mesh in the +/// XZ plane, centered at the origin. class CircleGenerator extends GeometryGenerator { late double _radius; late int _segments; @@ -20,6 +18,11 @@ class CircleGenerator extends GeometryGenerator { @override int get indexCount => _segments * 3; + /// Creates a circle mesh of the given [radius]. + /// + /// [segments] controls how many triangles are used around the + /// circumference. [thetaStart] and [thetaLength] can be used to generate + /// only a slice of the circle, both given in radians. MeshGeometry createCircle( double radius, { GeometryGeneratorFlags? flags, diff --git a/packages/vector_math/pubspec.yaml b/packages/vector_math/pubspec.yaml index 89b201e2..fa38b2ed 100644 --- a/packages/vector_math/pubspec.yaml +++ b/packages/vector_math/pubspec.yaml @@ -5,7 +5,7 @@ name: vector_math description: A vector math library for 2D and 3D applications, supporting 2D, 3D, and 4D matrices. repository: https://github.com/flutter/core-packages/tree/main/packages/vector_math issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+vector_math%22 -version: 2.4.2 +version: 2.4.3 environment: sdk: ^3.10.0 From 853ab67d2acab8b95ae0c87f81070d56ddbffb8e Mon Sep 17 00:00:00 2001 From: Faisal Ansari Date: Fri, 11 Sep 2026 21:25:40 +0530 Subject: [PATCH 2/3] Update packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart Co-authored-by: Tong Mu --- .../generators/circle_generator.dart | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart b/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart index 08b0bbe0..3e7115ba 100644 --- a/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart +++ b/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart @@ -20,9 +20,12 @@ class CircleGenerator extends GeometryGenerator { /// Creates a circle mesh of the given [radius]. /// - /// [segments] controls how many triangles are used around the - /// circumference. [thetaStart] and [thetaLength] can be used to generate - /// only a slice of the circle, both given in radians. + /// The [segments] parameter controls how many triangles are used around the + /// circumference. The [thetaStart] and [thetaLength] parameters can be used + /// to generate only a slice of the circle, both given in radians. + /// + /// The [flags] parameter configures which vertex attributes to generate, and + /// [filters] specifies any mesh transformations to apply after generation. MeshGeometry createCircle( double radius, { GeometryGeneratorFlags? flags, From d94cc57da390671ef86ac2400d2642ed8f7fe3c7 Mon Sep 17 00:00:00 2001 From: Faisal Ansari Date: Fri, 11 Sep 2026 21:27:26 +0530 Subject: [PATCH 3/3] Update documentation for CircleGenerator class --- .../src/vector_math_geometry/generators/circle_generator.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart b/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart index 3e7115ba..c6fbca7c 100644 --- a/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart +++ b/packages/vector_math/lib/src/vector_math_geometry/generators/circle_generator.dart @@ -4,7 +4,7 @@ part of '../../../vector_math_geometry.dart'; -/// Generates a flat, circular (or partial circle/pie-slice) mesh in the +/// Generates a flat circular or partial-circle (sector) mesh in the /// XZ plane, centered at the origin. class CircleGenerator extends GeometryGenerator { late double _radius;