Skip to content

[path_parsing] Add documentation for public API members in path_parsing#11640

Draft
mozammal-hossain wants to merge 3 commits intoflutter:mainfrom
mozammal-hossain:fix/path-parsing-public-api
Draft

[path_parsing] Add documentation for public API members in path_parsing#11640
mozammal-hossain wants to merge 3 commits intoflutter:mainfrom
mozammal-hossain:fix/path-parsing-public-api

Conversation

@mozammal-hossain
Copy link
Copy Markdown

@mozammal-hossain mozammal-hossain commented May 4, 2026

Adds comprehensive documentation for all public API members in the path_parsing
package, addressing the TODO to remove the public_member_api_docs lint ignore.

What changed:

  • Added dartdoc comments for all public classes, methods, and properties
  • Documented PathProxy interface (moveTo, lineTo, cubicTo, close)
  • Documented SvgPathStringSource parsing API
  • Documented PathSegmentData segment representation
  • Documented SvgPathNormalizer and helper functions
  • Removed public_member_api_docs from lint ignores in ignore_for_file

Fixes: flutter/flutter#157939

Pre-Review Checklist

No tests needed for doc-only changes (covered by test exemption).

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Footnotes

  1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. 2

Copy link
Copy Markdown

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

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 adds documentation for all public API members in the path_parsing package and removes the corresponding lint suppression. Documentation was added to the PathProxy, SvgPathStringSource, PathSegmentData, and SvgPathNormalizer classes, as well as several utility functions. A review comment suggests generalizing the documentation for the PathSegmentData constructor to accurately reflect all initialized fields.

Comment thread third_party/packages/path_parsing/lib/src/path_parsing.dart Outdated
@mozammal-hossain mozammal-hossain force-pushed the fix/path-parsing-public-api branch 2 times, most recently from cccae66 to ab8308d Compare May 5, 2026 08:19
@mozammal-hossain mozammal-hossain force-pushed the fix/path-parsing-public-api branch from ab8308d to c6ae7f5 Compare May 5, 2026 08:20
@mozammal-hossain mozammal-hossain force-pushed the fix/path-parsing-public-api branch from 36e4891 to 5d19384 Compare May 5, 2026 08:29
@stuartmorgan-g stuartmorgan-g marked this pull request as draft May 5, 2026 14:15
@stuartmorgan-g
Copy link
Copy Markdown
Collaborator

Marking as a draft per https://discord.com/channels/608014603317936148/1496222412767887483/1501225797057253527

Once this has passed review from a community member familiar with the Flutter review process, please mark it as ready for team review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[path_parsing] Add docs for public APIs

2 participants