add inline documentation

conceptadev · Dec 3, 2024 · 5824b1f · 5824b1f
1 parent cd8ea71
commit 5824b1f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/packages/mix/lib/src/theme/tokens/breakpoints_token.dart b/packages/mix/lib/src/theme/tokens/breakpoints_token.dart
@@ -77,13 +77,13 @@ class BreakpointToken extends MixToken<Breakpoint> {
   }
 }
 
-/// A resolver for breakpoint tokens.
+/// {@macro mix.token.resolver}
 @immutable
 class BreakpointResolver extends Breakpoint with WithTokenResolver<Breakpoint> {
   @override
   final BuildContextResolver<Breakpoint> resolve;
 
-  /// Creates a new breakpoint resolver with the given [resolve] function.
+  /// {@macro mix.token.resolver}
   const BreakpointResolver(this.resolve);
 }
 

diff --git a/packages/mix/lib/src/theme/tokens/color_token.dart b/packages/mix/lib/src/theme/tokens/color_token.dart
@@ -102,15 +102,20 @@ class ColorSwatchToken<T> extends ColorToken {
   }
 }
 
-/// A color resolver that allows dynamic resolution of a color value.
+/// {@template mix.token.resolver}
+/// A resolver that allows dynamic resolution of a token value.
 ///
-/// This is useful when the color value is dependent on the current [BuildContext],
+/// This is useful when the token value is dependent on the current [BuildContext],
 /// and cannot be resolved statically.
+///
+/// For more information, see [Dynamic Themes](https://www.fluttermix.com/docs/guides/design-token#dynamic-themes).
+/// {@endtemplate}
 class ColorResolver extends Color with WithTokenResolver<Color> {
   /// The function used to resolve the color value dynamically.
   @override
   final BuildContextResolver<Color> resolve;
 
+  /// {@macro mix.token.resolver}
   const ColorResolver(this.resolve) : super(0);
 }
 

diff --git a/packages/mix/lib/src/theme/tokens/radius_token.dart b/packages/mix/lib/src/theme/tokens/radius_token.dart
@@ -26,11 +26,13 @@ class RadiusToken extends MixToken<Radius> {
   }
 }
 
+/// {@macro mix.token.resolver}
 @immutable
 class RadiusResolver extends Radius with WithTokenResolver<Radius> {
   @override
   final BuildContextResolver<Radius> resolve;
 
+  /// {@macro mix.token.resolver}
   const RadiusResolver(this.resolve) : super.circular(0);
 }
 

diff --git a/packages/mix/lib/src/theme/tokens/text_style_token.dart b/packages/mix/lib/src/theme/tokens/text_style_token.dart
@@ -26,6 +26,7 @@ class TextStyleToken extends MixToken<TextStyle> {
   }
 }
 
+/// {@macro mix.token.resolver}
 @immutable
 class TextStyleResolver extends TextStyle with WithTokenResolver<TextStyle> {
   @override