Skip to content

Commit c052f4f

Browse files
docs: create release notes for v1.5.1
1 parent 63d3e92 commit c052f4f

1 file changed

Lines changed: 64 additions & 0 deletions

File tree

RELEASE_v1.5.1.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Engine Tracking v1.5.1
2+
3+
## 📚 Public API Documentation Release
4+
5+
This release focuses on improving developer experience through comprehensive public API documentation and resolving code quality issues.
6+
7+
## 🎯 What's New
8+
9+
### ✅ Complete Public API Documentation
10+
- **562+ lines** of documentation added across **32 files**
11+
- **All public members** now have proper Dartdoc comments (///)
12+
- **Full compliance** with `public_member_api_docs` lint rule
13+
- **Zero lint issues** - from 38 issues to 0
14+
15+
### 🔧 Bug Fixes
16+
- **Deprecated Warning Resolved**: Fixed `userId` deprecation warning in Clarity adapter
17+
- **Code Quality**: Improved maintainability and readability
18+
- **Future-Proof**: Resolved deprecation warnings for upcoming versions
19+
20+
## 📊 Technical Details
21+
22+
### Files Documented
23+
- `lib/src/bug_tracking/engine_bug_tracking.dart` - Methods and getters
24+
- `lib/src/config/engine_http_tracking_config.dart` - Class and constructor
25+
- `lib/src/http/engine_http_override.dart` - Class and constructor
26+
- `lib/src/observers/engine_navigator_observer.dart` - Class and fields
27+
- `lib/src/session/engine_session.dart` - Class, singleton, getters and methods
28+
- `lib/src/utils/engine_util.dart` - Typedefs and utility functions
29+
- `lib/src/widgets/engine_mask_widget.dart` - Constructors and fields
30+
- `lib/src/widgets/engine_stateful_widget.dart` - Class, constructors, getters and methods
31+
- `lib/src/widgets/engine_stateless_widget.dart` - Constructor
32+
- `lib/src/widgets/engine_widget.dart` - Constructor
33+
34+
### Quality Metrics
35+
- **Lint Status**: ✅ 0 issues found (`dart analyze`)
36+
- **Documentation Coverage**: ✅ 100% of public API members
37+
- **Code Standards**: ✅ Follows project documentation standards
38+
- **Breaking Changes**: ❌ None - only documentation additions
39+
40+
## 🚀 Benefits
41+
42+
1. **Better Developer Experience**: Complete API documentation for all public members
43+
2. **Lint Compliance**: Full compliance with `public_member_api_docs` rule
44+
3. **Code Quality**: Improved code maintainability and readability
45+
4. **Future-Proof**: Resolved deprecation warnings for upcoming versions
46+
47+
## 📦 Installation
48+
49+
```yaml
50+
dependencies:
51+
engine_tracking: ^1.5.1
52+
```
53+
54+
## 🔄 Migration
55+
56+
No migration required - this is a documentation-only release with no breaking changes.
57+
58+
## 📝 Changelog
59+
60+
See [CHANGELOG.md](CHANGELOG.md) for detailed information about this release.
61+
62+
---
63+
64+
**Engine Tracking** - Complete Flutter tracking, analytics, and bug reporting library with support for Firebase, Microsoft Clarity, Grafana Faro, Splunk, and Google Cloud Logging.

0 commit comments

Comments
 (0)