Improve documentation

Author: theEvilReaper

lib/api/base_api.dart

@@ -9,11 +9,11 @@ import 'package:stelaris/api/paginated_result.dart';
 /// This class assumes that the API endpoints and request/response formats follow a specific and consistent pattern across all models using this base.
 ///
 /// For example, it expects the following endpoint structure for each model type:
-///   - GET    /<endpoint>
-///   - POST   /<endpoint>
-///   - GET    /<endpoint>/all
-///   - POST   /<endpoint>/update
-///   - DELETE /<endpoint>/delete/<id>
+///   - GET    `/endpoint`
+///   - POST   `/endpoint`
+///   - GET    `/endpoint/all`
+///   - POST   `/endpoint/update`
+///   - DELETE `/endpoint/delete/{id}`
 ///
 /// Only use this base class when your API strictly adheres to this pattern for all CRUD operations. If your endpoints or data formats differ, consider implementing a custom service instead.
 ///

lib/api/converter/paginated_result_converter.dart

@@ -2,7 +2,7 @@ import 'package:freezed_annotation/freezed_annotation.dart';
 import 'package:stelaris/api/model/data_model.dart';
 import 'package:stelaris/api/paginated_result.dart';
 
-/// A generic JSON converter for any PaginatedResult<T>.
+/// A generic JSON converter for any PaginatedResult`<T>`.
 /// - T must extend DataModel. The converter does not require T to have fromJson or toJson methods; instead, these must be provided via function parameters.
 /// It requires two functions to be passed to its constructor:
 /// - [fromJsonT]: A function that can convert a JSON map into an object of type T.