improve docs of includeCustomMappers

schultek · Sep 25, 2024 · 8ba8b51 · 8ba8b51
1 parent 4777e79
commit 8ba8b51
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/packages/dart_mappable/doc/custom.md b/packages/dart_mappable/doc/custom.md
@@ -49,7 +49,9 @@ class Domain {
 }
 ```
 
-Alternatively you can add this to the `MapperContainer.globals` to be globally available to all other mappers.
+This will **globally** register the custom mapper when the class is initialized and is afterwards available for all models.
+
+Alternatively you can manually add this to the `MapperContainer.globals`:
 
 ```dart
 void main() {

diff --git a/packages/dart_mappable/lib/src/annotations.dart b/packages/dart_mappable/lib/src/annotations.dart
@@ -190,8 +190,12 @@ abstract class MappableInterface {
   /// using the `|` operator.
   final int? generateMethods;
 
-  /// Specify additional custom mappers that should be included for fields
+  /// Specify additional custom mappers that should be used for fields
   /// of this class.
+  ///
+  /// This does not scope the mappers to this class only. All mappers are always
+  /// registered globally and available to all classes. This only makes sure
+  /// that the needed mappers are registered before they are needed for this class.
   final Iterable<MapperBase>? includeCustomMappers;
 }