[webview_flutter] Document NavigationDelegate callbacks#11921
[webview_flutter] Document NavigationDelegate callbacks#11921saurabh-mirajkar wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation template for the NavigationDelegate constructor in packages/webview_flutter/webview_flutter/lib/src/navigation_delegate.dart to include descriptions for several callback parameters, including onNavigationRequest, onPageStarted, onPageFinished, onProgress, onWebResourceError, and onHttpError, while also making minor formatting adjustments to existing callback descriptions. There are no review comments, and I have no feedback to provide.
I'm not seeing this step in the PR. |
@stuartmorgan-g Thanks for pointing that out. I've updated the PR description to explain why I didn't include version or CHANGELOG updates, since this change only adds documentation for existing callbacks and does not modify package behavior. If public API documentation changes are expected to include versioning or CHANGELOG updates under the packages repository policy, I'm happy to add them. |
Description
Adds documentation for callback parameters accepted by
NavigationDelegate.Previously, the constructor documentation only described
onUrlChange,onHttpAuthRequest, andonSslAuthError, while other commonly used callbacks such asonNavigationRequest,onPageStarted,onPageFinished,onProgress,onWebResourceError, andonHttpErrorwere undocumented.This change updates the NavigationDelegate constructor documentation to cover all supported callbacks and improves consistency in the existing descriptions.
Fixes flutter/flutter#187780
Tests
Tests are not needed because this is a documentation-only change.
Version and CHANGELOG
No version or CHANGELOG updates are included because this change only adds documentation for existing callbacks and does not modify package behavior. If versioning updates are expected for public API documentation changes, I'm happy to add them.
Pre-Review Checklist
[shared_preferences]///).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-assistbot 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
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