Skip to content

[vector_math] Document geometry filter APIs#22

Open
faheemabbas766 wants to merge 2 commits into
flutter:mainfrom
faheemabbas766:faheemabbas766-vector-math-filter-docs
Open

[vector_math] Document geometry filter APIs#22
faheemabbas766 wants to merge 2 commits into
flutter:mainfrom
faheemabbas766:faheemabbas766-vector-math-filter-docs

Conversation

@faheemabbas766

@faheemabbas766 faheemabbas766 commented Jun 10, 2026

Copy link
Copy Markdown

Documents the public Plane API in vector_math and vector_math_64.

This removes the file-level public_member_api_docs ignore from both Plane implementations by documenting the public constructors, properties, and methods.

Part of flutter/flutter#186827

Validation

dart analyze
dart test test/plane_test.dart

@github-actions github-actions Bot added p: vector_math triage-framework Should be looked at in framework triage labels Jun 10, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request removes public API documentation ignore rules and adds doc comments to various geometry filter classes in vector_math_geometry. Feedback suggests clarifying the documentation regarding in-place mesh mutation for inplace and InplaceGeometryFilter, and optimizing the requires and generates getters in GeometryFilter by returning const empty lists to avoid unnecessary allocations.

Comment thread packages/vector_math/lib/src/vector_math_geometry/filters/geometry_filter.dart Outdated
Comment thread packages/vector_math/lib/src/vector_math_geometry/filters/geometry_filter.dart Outdated
Comment thread packages/vector_math/lib/src/vector_math_geometry/filters/geometry_filter.dart Outdated
Comment thread packages/vector_math/lib/src/vector_math_geometry/filters/geometry_filter.dart Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

p: vector_math triage-framework Should be looked at in framework triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant