[vector_math] Document geometry filter APIs#22
Conversation
There was a problem hiding this comment.
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.
|
Thank you for your contribution! Because of the volume of PRs we receive, we require that new contributors use our checklist to guide them through critical steps in creating a Flutter PR. This PR's description is missing that checklist, so it is being marked as a Draft. Please edit the PR description to add the checklist, then ensure that you have completed all of the steps. Once you've done that, please mark the PR as ready for review. If you need help, consider asking for advice on the #hackers-new channel on Discord. |
There was a problem hiding this comment.
Code Review
This pull request removes the public member API documentation ignore rules and adds documentation comments to several geometry filter classes, including BarycentricFilter, ColorFilter, FlatShadeFilter, GeometryFilter, InplaceGeometryFilter, InvertFilter, and TransformFilter. Additionally, the requires and generates getters in GeometryFilter are updated to return constant empty lists. There are no review comments, so no feedback is provided.
|
Following the source-repo guidance from #12, I’ve submitted these vector_math documentation changes upstream here: google/vector_math.dart#373 This upstream PR includes the geometry filter docs from this PR as well as the related Plane API docs. |
Documents the public geometry filter APIs in
vector_math.This removes
public_member_api_docsignores from geometry filter implementations by adding doc comments for the public filter classes, constructors, properties, and methods.Part of flutter/flutter#186827.
Validation
dart format --set-exit-if-changed lib/src/vector_math_geometry/filters/barycentric_filter.dart lib/src/vector_math_geometry/filters/color_filter.dart lib/src/vector_math_geometry/filters/flat_shade_filter.dart lib/src/vector_math_geometry/filters/geometry_filter.dart lib/src/vector_math_geometry/filters/invert_filter.dart lib/src/vector_math_geometry/filters/transform_filter.dartdart analyzedart test test/geometry_test.dart test/plane_test.dartPre-Review Checklist
[shared_preferences]///).This PR only adds documentation for existing APIs and removes
public_member_api_docsignores; it does not change runtime behavior.Footnotes
This PR is a documentation-only change for existing APIs, so no new runtime tests were added. ↩ ↩2