Skip to content

Commit 0975dd8

Browse files
TheBuggedYRNHeshamMegid
authored andcommitted
[MOB-10900] Remove Internals from API Reference (#306)
After migrating to pigeon in #279, a lot of internal APIs got exposed in the public API Reference of v11.5.0. This is fixed by: 1. Moving generated directory under src. 2. Adding @Nodoc comments to internal methods.
1 parent 496ee15 commit 0975dd8

20 files changed

+44
-21
lines changed

lib/src/modules/apm.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import 'dart:async';
44

5-
import 'package:instabug_flutter/generated/apm.api.g.dart';
5+
import 'package:instabug_flutter/src/generated/apm.api.g.dart';
66
import 'package:instabug_flutter/src/models/network_data.dart';
77
import 'package:instabug_flutter/src/models/trace.dart';
88
import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
@@ -21,6 +21,7 @@ enum LogLevel {
2121
class APM {
2222
static var _host = ApmHostApi();
2323

24+
/// @nodoc
2425
@visibleForTesting
2526
// ignore: use_setters_to_change_properties
2627
static void $setHostApi(ApmHostApi host) {

lib/src/modules/bug_reporting.dart

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import 'dart:async';
44

5-
import 'package:instabug_flutter/generated/bug_reporting.api.g.dart';
5+
import 'package:instabug_flutter/src/generated/bug_reporting.api.g.dart';
66
import 'package:instabug_flutter/src/modules/instabug.dart';
77
import 'package:instabug_flutter/src/utils/enum_converter.dart';
88
import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
@@ -44,22 +44,28 @@ class BugReporting implements BugReportingFlutterApi {
4444
static OnSDKInvokeCallback? _onInvokeCallback;
4545
static OnSDKDismissCallback? _onDismissCallback;
4646

47+
/// @nodoc
4748
@visibleForTesting
4849
// ignore: use_setters_to_change_properties
4950
static void $setHostApi(BugReportingHostApi host) {
5051
_host = host;
5152
}
5253

54+
/// @nodoc
5355
@internal
5456
static void init() {
5557
BugReportingFlutterApi.setup(_instance);
5658
}
5759

60+
/// @nodoc
61+
@internal
5862
@override
5963
void onSdkInvoke() {
6064
_onInvokeCallback?.call();
6165
}
6266

67+
/// @nodoc
68+
@internal
6369
@override
6470
void onSdkDismiss(String dismissType, String reportType) {
6571
final dismissTypeKey = dismissType.toUpperCase();

lib/src/modules/crash_reporting.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import 'dart:async';
44
import 'dart:convert';
55

66
import 'package:flutter/foundation.dart';
7-
import 'package:instabug_flutter/generated/crash_reporting.api.g.dart';
7+
import 'package:instabug_flutter/src/generated/crash_reporting.api.g.dart';
88
import 'package:instabug_flutter/src/models/crash_data.dart';
99
import 'package:instabug_flutter/src/models/exception_data.dart';
1010
import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
@@ -14,6 +14,7 @@ class CrashReporting {
1414
static var _host = CrashReportingHostApi();
1515
static bool enabled = true;
1616

17+
/// @nodoc
1718
@visibleForTesting
1819
// ignore: use_setters_to_change_properties
1920
static void $setHostApi(CrashReportingHostApi host) {

lib/src/modules/feature_requests.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import 'dart:async';
44

5-
import 'package:instabug_flutter/generated/feature_requests.api.g.dart';
5+
import 'package:instabug_flutter/src/generated/feature_requests.api.g.dart';
66
import 'package:instabug_flutter/src/utils/enum_converter.dart';
77
import 'package:meta/meta.dart';
88

@@ -11,6 +11,7 @@ enum ActionType { requestNewFeature, addCommentToFeature }
1111
class FeatureRequests {
1212
static var _host = FeatureRequestsHostApi();
1313

14+
/// @nodoc
1415
@visibleForTesting
1516
// ignore: use_setters_to_change_properties
1617
static void $setHostApi(FeatureRequestsHostApi host) {

lib/src/modules/instabug.dart

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import 'dart:ui';
1010

1111
import 'package:flutter/material.dart';
1212
import 'package:flutter/services.dart';
13-
import 'package:instabug_flutter/generated/instabug.api.g.dart';
1413
import 'package:instabug_flutter/instabug_flutter.dart';
14+
import 'package:instabug_flutter/src/generated/instabug.api.g.dart';
1515
import 'package:instabug_flutter/src/utils/enum_converter.dart';
1616
import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
1717
import 'package:meta/meta.dart';
@@ -118,12 +118,14 @@ enum ReproStepsMode { enabled, disabled, enabledWithNoScreenshots }
118118
class Instabug {
119119
static var _host = InstabugHostApi();
120120

121+
/// @nodoc
121122
@visibleForTesting
122123
// ignore: use_setters_to_change_properties
123124
static void $setHostApi(InstabugHostApi host) {
124125
_host = host;
125126
}
126127

128+
/// @nodoc
127129
@internal
128130
static void init() {
129131
BugReporting.init();

lib/src/modules/instabug_log.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
import 'dart:async';
44

5-
import 'package:instabug_flutter/generated/instabug_log.api.g.dart';
5+
import 'package:instabug_flutter/src/generated/instabug_log.api.g.dart';
66
import 'package:meta/meta.dart';
77

88
class InstabugLog {
99
static var _host = InstabugLogHostApi();
1010

11+
/// @nodoc
1112
@visibleForTesting
1213
// ignore: use_setters_to_change_properties
1314
static void $setHostApi(InstabugLogHostApi host) {

lib/src/modules/network_logger.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
import 'dart:async';
44

5-
import 'package:instabug_flutter/generated/instabug.api.g.dart';
5+
import 'package:instabug_flutter/src/generated/instabug.api.g.dart';
66
import 'package:instabug_flutter/src/models/network_data.dart';
77
import 'package:instabug_flutter/src/modules/apm.dart';
88
import 'package:meta/meta.dart';
99

1010
class NetworkLogger {
1111
static var _host = InstabugHostApi();
1212

13+
/// @nodoc
1314
@visibleForTesting
1415
// ignore: use_setters_to_change_properties
1516
static void $setHostApi(InstabugHostApi host) {

lib/src/modules/replies.dart

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import 'dart:async';
44

5-
import 'package:instabug_flutter/generated/replies.api.g.dart';
5+
import 'package:instabug_flutter/src/generated/replies.api.g.dart';
66
import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
77
import 'package:meta/meta.dart';
88

@@ -24,17 +24,21 @@ class Replies implements RepliesFlutterApi {
2424

2525
static OnNewReplyReceivedCallback? _onNewReplyReceivedCallback;
2626

27+
/// @nodoc
2728
@visibleForTesting
2829
// ignore: use_setters_to_change_properties
2930
static void $setHostApi(RepliesHostApi host) {
3031
_host = host;
3132
}
3233

34+
/// @nodoc
3335
@internal
3436
static void init() {
3537
RepliesFlutterApi.setup(_instance);
3638
}
3739

40+
/// @nodoc
41+
@internal
3842
@override
3943
void onNewReply() {
4044
_onNewReplyReceivedCallback?.call();

lib/src/modules/surveys.dart

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import 'dart:async';
44

5-
import 'package:instabug_flutter/generated/surveys.api.g.dart';
5+
import 'package:instabug_flutter/src/generated/surveys.api.g.dart';
66
import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
77
import 'package:meta/meta.dart';
88

@@ -26,22 +26,28 @@ class Surveys implements SurveysFlutterApi {
2626
static OnShowSurveyCallback? _onShowCallback;
2727
static OnDismissSurveyCallback? _onDismissCallback;
2828

29+
/// @nodoc
2930
@visibleForTesting
3031
// ignore: use_setters_to_change_properties
3132
static void $setHostApi(SurveysHostApi host) {
3233
_host = host;
3334
}
3435

36+
/// @nodoc
3537
@internal
3638
static void init() {
3739
SurveysFlutterApi.setup(_instance);
3840
}
3941

42+
/// @nodoc
43+
@internal
4044
@override
4145
void onShowSurvey() {
4246
_onShowCallback?.call();
4347
}
4448

49+
/// @nodoc
50+
@internal
4551
@override
4652
void onDismissSurvey() {
4753
_onDismissCallback?.call();

scripts/pigeon.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
22

3-
DIR_DART="lib/generated"
3+
DIR_DART="lib/src/generated"
44
DIR_IOS="ios/Classes/Generated"
55
DIR_ANDROID="android/src/main/java/com/instabug/flutter/generated"
66
PKG_ANDROID="com.instabug.flutter.generated"

0 commit comments

Comments
 (0)