📝 Refine comments for clarity and readability

leo-lox · Nov 15, 2024 · 5e29eed · 5e29eed
1 parent 3ea4a7e
commit 5e29eed
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/lib/presentation_layer/providers/inbox_outbox_provider.dart b/lib/presentation_layer/providers/inbox_outbox_provider.dart
@@ -6,6 +6,9 @@ import '../../domain_layer/repositories/inbox_outbox_repository.dart';
 import '../../domain_layer/usecases/inbox_outbox.dart';
 import 'ndk_provider.dart';
 
+// Provider for managing the "InboxOutbox" use case.
+// This provider creates and returns an instance of InboxOutbox, 
+// which handles operations related to inbox and outbox functionality.
 final inboxOutboxProvider = Provider<InboxOutbox>((ref) {
   final ndk = ref.watch(ndkProvider);
 
@@ -19,5 +22,6 @@ final inboxOutboxProvider = Provider<InboxOutbox>((ref) {
     repository: inboxOutboxRepository,
   );
 
+  // Returns the InboxOutbox instance
   return inboxOutbox;
 });
diff --git a/lib/presentation_layer/providers/metadata_provider.dart b/lib/presentation_layer/providers/metadata_provider.dart
@@ -7,6 +7,9 @@ import '../../domain_layer/usecases/get_user_metadata.dart';
 import 'event_verifier.dart';
 import 'ndk_provider.dart';
 
+// Provider for managing the "GetUserMetadata" use case.
+// This provider creates and returns an instance of GetUserMetadata, 
+// which is used to fetch user metadata from the repository.
 final metadataProvider = Provider<GetUserMetadata>((ref) {
   final ndk = ref.watch(ndkProvider);
 
@@ -21,5 +24,6 @@ final metadataProvider = Provider<GetUserMetadata>((ref) {
 
   final GetUserMetadata getUserMetadata = GetUserMetadata(metadataRepository);
 
+  // Returns the GetUserMetadata instance, which can be used to fetch user metadata.
   return getUserMetadata;
 });