Skip to content

Commit 5ab29f7

Browse files
committed
docs: update bugsee manager class comment documentations
1 parent 7bcaeba commit 5ab29f7

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

src/app/lib/business/bugsee/bugsee_manager.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,34 @@ import 'package:logger/web.dart';
1111
const String bugseeTokenFormat =
1212
r'^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$';
1313

14-
///Service related to initializing Bugsee service
14+
/// Service related to initializing Bugsee service
1515
abstract interface class BugseeManager {
1616
factory BugseeManager({
1717
required Logger logger,
1818
required BugseeRepository bugseeRepository,
1919
}) = _BugseeManager;
2020

21-
/// indicate if the app require a restart to reactivate the bugsee configurations
21+
/// Indicate if the app require a restart to reactivate the bugsee configurations
2222
///
2323
/// `true` only if `isConfigurationValid == true` and bugsee is turned on
2424
bool get isRestartRequired;
2525

26-
/// indicate if bugsee is enabled or not
26+
/// Indicate if bugsee is enabled or not
2727
/// by default bugsee is enabled if `isConfigurationValid == true`.
2828
bool get isBugseeEnabled;
2929

30-
/// indicate whether video capturing is enabled or not.
30+
/// Indicate whether video capturing is enabled or not.
3131
/// enabled by default if `isBugseeEnabled == true`.
3232
///
3333
/// cannot be true if `isBugseeEnabled == false`.
3434
bool get isVideoCaptureEnabled;
3535

36-
/// indicate if bugsee configuration is valid
36+
/// Indicate if bugsee configuration is valid
3737
/// config is valid if app in release mode and the provided token is valid
3838
/// following the [bugseeTokenFormat] regex.
3939
bool get isConfigurationValid;
4040

41-
/// initialize bugsee with given token
41+
/// Initialize bugsee with given token
4242
/// bugsee is not available in debug mode
4343
/// * [bugseeToken]: nullable bugsee token, if null bugsee won't be initialized make sure you provide
4444
/// [BUGSEE_TOKEN] in the env using `--dart-define` or `launch.json` on vscode

0 commit comments

Comments
 (0)