From fc28e01375c10b3e509271212e7c391654cb6b88 Mon Sep 17 00:00:00 2001 From: Michael Bui <25263378+MaikuB@users.noreply.github.com> Date: Tue, 17 Apr 2018 21:19:27 +1000 Subject: [PATCH] Update code documentation --- .../initialization_settings/initialization_settings.dart | 3 +++ .../notification_details/notification_details.dart | 4 ++++ .../notification_details/notification_details_android.dart | 4 +++- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/lib/platform_specifics/initialization_settings/initialization_settings.dart b/lib/platform_specifics/initialization_settings/initialization_settings.dart index 9ab80ee3b..74078bd78 100644 --- a/lib/platform_specifics/initialization_settings/initialization_settings.dart +++ b/lib/platform_specifics/initialization_settings/initialization_settings.dart @@ -3,7 +3,10 @@ import 'package:flutter_local_notifications/platform_specifics/initialization_se /// Settings for initializing the plugin for each platform class InitializationSettings { + /// Settings for Android final InitializationSettingsAndroid android; + + /// Settings for iOS final InitializationSettingsIOS ios; const InitializationSettings(this.android, this.ios); diff --git a/lib/platform_specifics/notification_details/notification_details.dart b/lib/platform_specifics/notification_details/notification_details.dart index 4d2d48785..91b76145d 100644 --- a/lib/platform_specifics/notification_details/notification_details.dart +++ b/lib/platform_specifics/notification_details/notification_details.dart @@ -3,7 +3,11 @@ import 'package:flutter_local_notifications/platform_specifics/notification_deta /// Contains notification settings for each platform class NotificationDetails { + /// Notification details for Android final NotificationDetailsAndroid android; + + /// Notification details for iOS final NotificationDetailsIOS iOS; + const NotificationDetails(this.android, this.iOS); } diff --git a/lib/platform_specifics/notification_details/notification_details_android.dart b/lib/platform_specifics/notification_details/notification_details_android.dart index 5bf9deeba..8fb281e49 100644 --- a/lib/platform_specifics/notification_details/notification_details_android.dart +++ b/lib/platform_specifics/notification_details/notification_details_android.dart @@ -6,8 +6,10 @@ import 'dart:typed_data'; import 'package:flutter_local_notifications/platform_specifics/android_styles/default_style_information.dart'; import 'package:flutter_local_notifications/platform_specifics/android_styles/style_information.dart'; +/// The available notification styles on Android enum NotificationStyleAndroid { Default, BigText } +/// Defines the available importance levels for Android notifications class Importance { static const Unspecified = const Importance(-1000); static const None = const Importance(0); @@ -24,7 +26,7 @@ class Importance { const Importance(this.value); } -// Notification priority for Android 7.1 and lower +// Priority for notifications on Android 7.1 and lower class Priority { static const Min = const Priority(-2); static const Low = const Priority(-1);