Skip to content

Commit dcd64e9

Browse files
committed
more doc comments
1 parent e92a9e9 commit dcd64e9

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

pkgs/native_assets_cli/lib/src/api/build_config.dart

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,18 @@ abstract final class BuildConfig implements HookConfig {
4545

4646
/// Whether link hooks will be run after the build hooks.
4747
///
48-
/// If [linkingEnabled] is true, [BuildOutput.addAsset] can be called with
49-
/// the `linkInPackage` parameter. If [linkingEnabled] is false, no assets
50-
/// should be added with the `linkInPackage` parameter set.
51-
///
52-
/// Link hooks are only run for release builds initiated by the following
53-
/// commands:
54-
/// - `flutter build` (release mode)
48+
/// If [linkingEnabled] is true, [BuildOutput.addAsset] may be called with the
49+
/// `linkInPackage` parameter so that assets can be linked in a link hook.
50+
/// Linking is enabled in Flutter release builds and Dart AOT configurations.
51+
/// These configurations are optimized for app size.
52+
/// - `flutter build`
5553
/// - `flutter run --release`
56-
/// - `dart build` (release mode)
54+
/// - `dart build`
5755
///
58-
/// Link hooks are not run for the following commands:
56+
/// If [linkingEnabled] is false, no assets should be added with the
57+
/// `linkInPackage` parameter set. All assets must be ready for bundling.
58+
/// Linking is disabled in Flutter debug builds and Dart JIT configurations.
59+
/// These configurations are optimized for development speed.
5960
/// - `dart run`
6061
/// - `flutter run` (debug mode)
6162
bool get linkingEnabled;

0 commit comments

Comments
 (0)