Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[native_assets_cli] Clarify meaning of targetAndroidNdkApi in docs #151

Merged
merged 2 commits into from
Oct 5, 2023
Merged

[native_assets_cli] Clarify meaning of targetAndroidNdkApi in docs #151

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a88d31a
[native_assets_cli] Clarify meaning of `targetAndroidNdkApi` in docs
blaugold Oct 4, 2023
7f3abb2
++
blaugold Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pkgs/native_assets_cli/lib/src/model/build_config.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ class BuildConfig {

/// When compiling for Android, the API version to target.
///
/// This property is not to be confused with
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe invert the sentence, so that we have what it is first. That is more important. Maybe even leave the what it is not out?

Something along the lines of:

  /// When compiling for Android, the minimum Android SDK API version to that the
  /// compiled code will be compatible with.
  ///
  /// Required when [targetOs] equals [OS.android].
  ///
  /// Not available in [dryRun].
  ///
  /// For more information about the Android API version, refer to
  /// [`minSdkVersion`](https://developer.android.com/ndk/guides/sdk-versions#minsdkversion)
  /// in the Android documentation.
  int? get targetAndroidNdkApi {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's much better. 😄

/// [`targetSdkVersion`](https://developer.android.com/ndk/guides/sdk-versions#targetsdkversion)
/// but is instead the
/// [`minSdkVersion`](https://developer.android.com/ndk/guides/sdk-versions#minsdkversion).
///
/// Required when [targetOs] equals [OS.android].
///
/// Not available in [dryRun].
Expand Down