mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-23 21:13:35 +00:00
264c4bbb88
- Add detailed English doc comments for all main annotations (inject, injectable, instance, provide, scope, etc) - Add fully documented example/example.dart illustrating real-world DI scenario - Clarify stub sections (Module class, generated mixins) - Aligns package with pub.dev quality and best practice requirements No breaking changes.
41 lines
1.3 KiB
Dart
41 lines
1.3 KiB
Dart
//
|
|
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
/// Annotations for use with the CherryPick dependency injection generator.
|
|
///
|
|
/// These annotations are used on classes, methods, fields or parameters to
|
|
/// describe how they should participate in dependency injection.
|
|
/// See: https://pub.dev/packages/cherrypick
|
|
///
|
|
/// Example:
|
|
/// ```dart
|
|
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
///
|
|
/// @injectable()
|
|
/// class MyService {
|
|
/// @inject()
|
|
/// late final Logger logger;
|
|
/// }
|
|
/// ```
|
|
library;
|
|
|
|
export 'src/module.dart';
|
|
export 'src/provide.dart';
|
|
export 'src/instance.dart';
|
|
export 'src/singleton.dart';
|
|
export 'src/named.dart';
|
|
export 'src/params.dart';
|
|
export 'src/inject.dart';
|
|
export 'src/injectable.dart';
|
|
export 'src/scope.dart';
|