docs: add public API documentation and fix deprecated userId warning #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Bugbot free trial expires on July 29, 2025
Learn more in the Cursor dashboard.
| /// | ||
| /// This class extends HttpOverrides to intercept HTTP requests and log them | ||
| /// using the Engine Tracking logging system. It provides detailed logging | ||
| /// of request/response data including timing, status codes, and headers. |
There was a problem hiding this comment.
Bug: Duplicate Documentation Comments in EngineHttpOverride
The EngineHttpOverride class has duplicated documentation comments, with the same block appearing twice consecutively, leading to redundant and confusing documentation.
Locations (1)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📚 Public API Documentation
This PR adds comprehensive public API documentation for all members across the Engine Tracking library, resolving 38 lint issues related to
public_member_api_docs.🔧 Changes Made
Files documented:
lib/src/bug_tracking/engine_bug_tracking.dart- Methods and getterslib/src/config/engine_http_tracking_config.dart- Class and constructorlib/src/http/engine_http_override.dart- Class and constructorlib/src/observers/engine_navigator_observer.dart- Class and fieldslib/src/session/engine_session.dart- Class, singleton, getters and methodslib/src/utils/engine_util.dart- Typedefs and utility functionslib/src/widgets/engine_mask_widget.dart- Constructors and fieldslib/src/widgets/engine_stateful_widget.dart- Class, constructors, getters and methodslib/src/widgets/engine_stateless_widget.dart- Constructorlib/src/widgets/engine_widget.dart- ConstructorBug fixes:
userIdwarning in Clarity adapter by usingcustomUserIdvariable✅ Quality Assurance
dart analyze)📊 Impact
🎯 Benefits
public_member_api_docsrule