diff --git a/cherrypick_annotations/lib/src/module.dart b/cherrypick_annotations/lib/src/module.dart index 90e3f7f..2c697d5 100644 --- a/cherrypick_annotations/lib/src/module.dart +++ b/cherrypick_annotations/lib/src/module.dart @@ -1,5 +1,24 @@ -/// Отмечает класс как injectable для автоматической регистрации. +/// An annotation used to mark a Dart class or library as a module. +/// +/// This annotation can be used for tooling, code generation, +/// or to provide additional metadata about the module. +/// +/// Example: +/// ```dart +/// @module() +/// abstract class AppModule extends Module { +/// } +/// ``` +/// Сгенерирует код: +/// ```dart +/// final class $AppModule extends AppModule { +/// @override +/// void builder(Scope currentScope) { +/// +/// } +/// } // ignore: camel_case_types -class module { +final class module { + /// Creates a [module] annotation. const module(); } diff --git a/cherrypick_annotations/lib/src/named.dart b/cherrypick_annotations/lib/src/named.dart index 5d7910c..deea54f 100644 --- a/cherrypick_annotations/lib/src/named.dart +++ b/cherrypick_annotations/lib/src/named.dart @@ -1,5 +1,31 @@ +/// An annotation to assign a name or identifier to a class, method, or other element. +/// +/// This can be useful for code generation, dependency injection, +/// or providing metadata within a framework. +/// +/// Example: +/// ```dart +/// @module() +/// abstract class AppModule extends Module { +/// @named('dio') +/// Dio dio() => Dio(); +/// } +/// ``` +/// +/// Сгенерирует код: +/// ```dart +/// final class $AppModule extends AppModule { +/// @override +/// void builder(Scope currentScope) { +/// bind().toProvide(() => dio()).withName('dio').singleton(); +/// } +/// } +/// ``` // ignore: camel_case_types -class named { +final class named { + /// The assigned name or identifier. final String value; + + /// Creates a [named] annotation with the given [value]. const named(this.value); } diff --git a/cherrypick_annotations/lib/src/singleton.dart b/cherrypick_annotations/lib/src/singleton.dart index 35eee76..0962f0c 100644 --- a/cherrypick_annotations/lib/src/singleton.dart +++ b/cherrypick_annotations/lib/src/singleton.dart @@ -1,4 +1,28 @@ +/// An annotation to declare a class as a singleton. +/// +/// This can be used to indicate that only one instance of the class +/// should be created, which is often useful in dependency injection +/// frameworks or service locators. +/// +/// Example: +/// ```dart +/// @module() +/// abstract class AppModule extends Module { +/// @singleton() +/// Dio dio() => Dio(); +/// } +/// ``` +/// Сгенерирует код: +/// ```dart +/// final class $AppModule extends AppModule { +/// @override +/// void builder(Scope currentScope) { +/// bind().toProvide(() => dio()).singleton(); +/// } +/// } +/// ``` // ignore: camel_case_types -class singleton { +final class singleton { + /// Creates a [singleton] annotation. const singleton(); }