minor changes

Author: sudhanshuGt

lib/core/network/dio_cleint.dart

@@ -3,29 +3,48 @@ import 'package:myapp/core/network/token_intercepter.dart';
 
 import '../constants/api_constants.dart';
 
+/* A singleton class that manages Dio HTTP client configuration
+ including base URL, timeouts, and interceptors. */
+
 class DioClient {
+  /* Private constructor for singleton pattern. */
   DioClient._();
+
+  /// The single shared instance of [DioClient].
   static final DioClient _instance = DioClient._();
+
+  /// Factory constructor that always returns the same instance.
   factory DioClient() => _instance;
 
+  /// The Dio instance used for making HTTP requests.
   late final Dio dio;
 
+  /* Initializes Dio with base options and interceptors.
+  Should be called once at app startup before making any network requests. */
   Future<void> init() async {
-    dio = Dio(BaseOptions(
-      baseUrl: ApiConstants.baseUrl,
-      connectTimeout: const Duration(seconds: 10),
-      receiveTimeout: const Duration(seconds: 10),
-      contentType: 'application/json',
-    ));
+    dio = Dio(
+      BaseOptions(
+        baseUrl: ApiConstants.baseUrl,
+        connectTimeout: const Duration(seconds: 10),
+        receiveTimeout: const Duration(seconds: 10),
+        contentType: 'application/json',
+      ),
+    );
+
+    ///  interceptor for attaching authentication tokens.
     dio.interceptors.add(TokenInterceptor());
-    dio.interceptors.add(LogInterceptor(
-      request: true,
-      requestHeader: true,
-      requestBody: true,
-      responseHeader: false,
-      responseBody: true,
-      error: true,
-      logPrint: (obj) => print("🔐 $obj"),
-    ));
+
+    /// Add log interceptor for debugging network calls.
+    dio.interceptors.add(
+      LogInterceptor(
+        request: true,
+        requestHeader: true,
+        requestBody: true,
+        responseHeader: false,
+        responseBody: true,
+        error: true,
+        logPrint: (obj) => print("🔐 $obj"), // Custom log format
+      ),
+    );
   }
-}
+}

lib/data/datasource/auth_remote_datesource.dart

@@ -1,24 +1,46 @@
 import 'package:dio/dio.dart';
 import '../../core/constants/api_constants.dart';
 import '../model/auth_response_model.dart';
- 
+
+/// Remote data source responsible for user authentication API calls.
+///
+/// Uses [Dio] for HTTP requests and maps API responses to [AuthResponseModel].
 class AuthRemoteDatasource {
   final Dio dio;
+
+  /// Creates an instance with the provided [dio] HTTP client.
   AuthRemoteDatasource(this.dio);
 
-  Future<AuthResponseModel> signUp(
-      {required String name,
-        required String email,
-        required String password}) async {
-    final res = await dio.post(ApiConstants.signUp,
-        data: {'name': name, 'email': email, 'password': password});
+  /// Registers a new user by sending a POST request to the signup endpoint.
+  ///
+  /// Requires [name], [email], and [password] for account creation.
+  /// Returns an [AuthResponseModel] containing the authentication token and other data.
+  /// Throws [DioError] if the network call fails or the server returns an error.
+  Future<AuthResponseModel> signUp({
+    required String name,
+    required String email,
+    required String password,
+  }) async {
+    final res = await dio.post(
+      ApiConstants.signUp,
+      data: {'name': name, 'email': email, 'password': password},
+    );
     return AuthResponseModel.fromJson(res.data);
   }
 
-  Future<AuthResponseModel> login(
-      {required String email, required String password}) async {
-    final res =
-    await dio.post(ApiConstants.login, data: {'email': email, 'password': password});
+  /// Logs in an existing user by sending a POST request to the login endpoint.
+  ///
+  /// Requires [email] and [password].
+  /// Returns an [AuthResponseModel] containing the authentication token and other data.
+  /// Throws [DioError] if the network call fails or the server returns an error.
+  Future<AuthResponseModel> login({
+    required String email,
+    required String password,
+  }) async {
+    final res = await dio.post(
+      ApiConstants.login,
+      data: {'email': email, 'password': password},
+    );
     return AuthResponseModel.fromJson(res.data);
   }
 }

lib/data/datasource/todo_remote_datasource.dart

@@ -2,26 +2,53 @@ import 'package:dio/dio.dart';
 import '../../core/constants/api_constants.dart';
 import '../model/todo_model.dart';
 
+/// Remote data source for fetching and modifying todos via REST API.
+///
+/// Uses [Dio] for making HTTP requests. Returns data layer models ([TodoModel])
+/// which are later converted to domain entities in the repository layer.
 class TodoRemoteDatasource {
   final Dio dio;
+
+  /// Creates a new instance with the given [dio] HTTP client.
   TodoRemoteDatasource(this.dio);
 
+  /// Fetches the list of todos from the remote API.
+  ///
+  /// Returns a list of [TodoModel] parsed from JSON.
+  /// Throws [DioError] if the network call fails.
   Future<List<TodoModel>> getTodos() async {
     final res = await dio.get(ApiConstants.todos);
-    return (res.data as List).map((e) => TodoModel.fromJson(e)).toList();
+    return (res.data as List)
+        .map((e) => TodoModel.fromJson(e))
+        .toList();
   }
 
+  /// Adds a new todo with the given [text].
+  ///
+  /// Returns the created [TodoModel] parsed from JSON.
+  /// Sets `completed` to `false` by default for new todos.
   Future<TodoModel> addTodo(String text) async {
-    final res = await dio.post(ApiConstants.todos,
-        data: {'todo': text, 'completed': false});
+    final res = await dio.post(
+      ApiConstants.todos,
+      data: {'todo': text, 'completed': false},
+    );
     return TodoModel.fromJson(res.data);
   }
 
+  /// Updates an existing todo represented by [m].
+  ///
+  /// Sends a PUT request to update the todo and returns the updated [TodoModel].
   Future<TodoModel> updateTodo(TodoModel m) async {
-    final res = await dio.put('${ApiConstants.todos}/${m.id}', data: m.toJson());
+    final res = await dio.put(
+      '${ApiConstants.todos}/${m.id}',
+      data: m.toJson(),
+    );
     return TodoModel.fromJson(res.data);
   }
 
+  /// Deletes a todo by its [id].
+  ///
+  /// Sends a DELETE request to the API. Does not return any data.
   Future<void> deleteTodo(int id) async {
     await dio.delete('${ApiConstants.todos}/$id');
   }

lib/data/repositories/auth_repositories_impl.dart

@@ -1,31 +1,53 @@
-
 import '../../core/error/exceptions.dart';
 import '../../domain/entities/token.dart';
 import '../../domain/repositories/auth_repository.dart';
 import '../datasource/auth_remote_datesource.dart';
 
+/// Implementation of [AuthRepository] that handles user authentication.
+///
+/// Uses a remote data source ([AuthRemoteDatasource]) to perform actual API calls
+/// and maps data models to domain entities ([Token]).
 class AuthRepositoryImpl implements AuthRepository {
   final AuthRemoteDatasource remote;
+
+  /// Constructor injecting the remote datasource.
   AuthRepositoryImpl(this.remote);
 
+  /// Registers a new user with [name], [email], and [password].
+  ///
+  /// Returns a [Token] on successful signup.
+  /// Throws a [ServerException] if any error occurs during the remote call.
   @override
   Future<Token> signUp(String name, String email, String password) async {
     try {
-      final model =
-      await remote.signUp(name: name, email: email, password: password);
+      final model = await remote.signUp(
+        name: name,
+        email: email,
+        password: password,
+      );
+      // Map remote model to domain entity
       return Token(model.token);
     } on Exception catch (e) {
+      // Wrap and rethrow as a domain-specific exception
       throw ServerException(e.toString());
     }
   }
 
+  /// Logs in a user with [email] and [password].
+  ///
+  /// Returns a [Token] on successful login.
+  /// Throws a [ServerException] if any error occurs during the remote call.
   @override
   Future<Token> login(String email, String password) async {
     try {
-      final model =
-      await remote.login(email: email, password: password);
+      final model = await remote.login(
+        email: email,
+        password: password,
+      );
+      // Map remote model to domain entity
       return Token(model.token);
     } on Exception catch (e) {
+      // Wrap and rethrow as a domain-specific exception
       throw ServerException(e.toString());
     }
   }

lib/data/repositories/todo_repositories.dart

@@ -1,4 +1,3 @@
-
 import 'package:myapp/data/mapper/todo_mapper.dart';
 
 import '../../core/error/exceptions.dart';
@@ -7,19 +6,34 @@ import '../../domain/repositories/todo_repository.dart';
 import '../datasource/todo_remote_datasource.dart';
 import '../model/todo_model.dart';
 
+/// Implementation of [TodoRepository] that communicates with the remote data source.
+///
+/// Converts between data layer models ([TodoModel]) and domain layer entities ([Todo]).
 class TodoRepositoryImpl implements TodoRepository {
   final TodoRemoteDatasource remote;
+
+  /// Creates an instance with the required [TodoRemoteDatasource].
   TodoRepositoryImpl(this.remote);
 
+  /// Retrieves all todos from the remote API.
+  ///
+  /// Returns a list of [Todo] entities mapped from [TodoModel].
+  /// Throws [ServerException] if a network or server error occurs.
   @override
   Future<List<Todo>> getTodos() async {
     try {
-      return (await remote.getTodos()).map((e) => e.toEntity()).toList();
+      return (await remote.getTodos())
+          .map((e) => e.toEntity()) // Map each data model to domain entity
+          .toList();
     } on Exception catch (e) {
       throw ServerException(e.toString());
     }
   }
 
+  /// Adds a new todo with the given [text].
+  ///
+  /// Returns the created [Todo] entity.
+  /// Throws [ServerException] if a network or server error occurs.
   @override
   Future<Todo> addTodo(String text) async {
     try {
@@ -29,20 +43,30 @@ class TodoRepositoryImpl implements TodoRepository {
     }
   }
 
+  /// Updates an existing [todo].
+  ///
+  /// Converts the [Todo] entity to a [TodoModel] before making the remote call.
+  /// Returns the updated [Todo] entity.
+  /// Throws [ServerException] if a network or server error occurs.
   @override
   Future<Todo> updateTodo(Todo todo) async {
     try {
-      return (await remote.updateTodo(TodoModel(
-        id: todo.id,
-        todo: todo.todo,
-        completed: todo.completed,
-      )))
+      return (await remote.updateTodo(
+        TodoModel(
+          id: todo.id,
+          todo: todo.todo,
+          completed: todo.completed,
+        ),
+      ))
           .toEntity();
     } on Exception catch (e) {
       throw ServerException(e.toString());
     }
   }
 
+  /// Deletes the todo with the specified [id].
+  ///
+  /// Throws [ServerException] if a network or server error occurs.
   @override
   Future<void> deleteTodo(int id) async {
     try {

lib/main.dart

@@ -1,29 +1,41 @@
-import 'package:flutter/material.dart';
-
 import 'package:flutter/material.dart';
 import 'package:get/get.dart';
 import 'package:myapp/routes/app_pages.dart';
 import 'package:myapp/routes/routes.dart';
 
 import 'di/service_locator.dart' as di;
 
+/// Entry point of the application.
 void main() async {
+  // Ensures that plugin services are initialized before runApp is called.
   WidgetsFlutterBinding.ensureInitialized();
+
+  // Initialize all dependencies (DI setup: repositories, use cases, controllers, etc.)
   await di.init();
+
+  // Launch the root widget of the app.
   runApp(const MyApp());
 }
 
+/// Root widget of the application.
+///
+/// Uses [GetMaterialApp] for routing and dependency injection.
 class MyApp extends StatelessWidget {
   const MyApp({super.key});
 
   @override
   Widget build(BuildContext context) {
     return GetMaterialApp(
-      title: 'Clean Todo',
+      title: 'My Todo',
+
+      // Define the initial screen of the app.
       initialRoute: Routes.login,
+
+      // Define the application's named routes.
       getPages: AppPages.pages,
+
+      // Disable the debug banner for production-like appearance.
       debugShowCheckedModeBanner: false,
     );
   }
 }
-