Skip to content

Update documentation snapshot. #97

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.

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

Merged
merged 1 commit into from
Sep 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# How to become a contributor and submit your own code

## Documentation

Note the all the documentation under docs/ is only a mirror;
the original documentation is maintained in the Android
source code repository:

https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/docs/

## Contributor License Agreements

We'd love to accept your sample apps and patches! Before we can take them, we
4 changes: 4 additions & 0 deletions docs/checks/AlertDialogUsage.md.html
Original file line number Diff line number Diff line change
@@ -89,6 +89,10 @@
[versions]
lint-rules-android = "0.25.0"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
lint-rules-android = {
module = "com.vanniktech:lint-rules-android",
version.ref = "lint-rules-android"
2 changes: 1 addition & 1 deletion docs/checks/AppLinkUrlError.md.html
Original file line number Diff line number Diff line change
@@ -58,7 +58,7 @@
package="test.pkg" >

<application>
<activity>
<activity android:name=".MainActivity">
<intent-filter android:autoVerify="true">
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
14 changes: 9 additions & 5 deletions docs/checks/ArcAnimationSpecTypeIssue.md.html
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@
Feedback
: https://issuetracker.google.com/issues/new?component=612128
Min
: Lint 7.0
: Lint 8.0 and 8.1
Compiled
: Lint 8.0 and 8.1
Artifact
@@ -99,25 +99,29 @@

```
// build.gradle.kts
implementation("androidx.compose.animation:animation-core-android:1.7.0-rc01")
implementation("androidx.compose.animation:animation-core-android:1.8.0-alpha02")

// build.gradle
implementation 'androidx.compose.animation:animation-core-android:1.7.0-rc01'
implementation 'androidx.compose.animation:animation-core-android:1.8.0-alpha02'

// build.gradle.kts with version catalogs:
implementation(libs.animation.core.android)

# libs.versions.toml
[versions]
animation-core-android = "1.7.0-rc01"
animation-core-android = "1.8.0-alpha02"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
animation-core-android = {
module = "androidx.compose.animation:animation-core-android",
version.ref = "animation-core-android"
}
```

1.7.0-rc01 is the version this documentation was generated from;
1.8.0-alpha02 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.compose.animation:animation-core-android](androidx_compose_animation_animation-core-android.md.html).
4 changes: 4 additions & 0 deletions docs/checks/ArgInFormattedQuantityStringRes.md.html
Original file line number Diff line number Diff line change
@@ -103,6 +103,10 @@
[versions]
slack-lint-checks = "0.7.4"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
module = "com.slack.lint:slack-lint-checks",
version.ref = "slack-lint-checks"
4 changes: 4 additions & 0 deletions docs/checks/AssertjImport.md.html
Original file line number Diff line number Diff line change
@@ -63,6 +63,10 @@
[versions]
lint-rules-android = "0.25.0"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
lint-rules-android = {
module = "com.vanniktech:lint-rules-android",
version.ref = "lint-rules-android"
4 changes: 4 additions & 0 deletions docs/checks/AutoDispose.md.html
Original file line number Diff line number Diff line change
@@ -107,6 +107,10 @@
[versions]
autodispose-lint = "2.2.1"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
autodispose-lint = {
module = "com.uber.autodispose2:autodispose-lint",
version.ref = "autodispose-lint"
12 changes: 8 additions & 4 deletions docs/checks/AutoboxingStateCreation.md.html
Original file line number Diff line number Diff line change
@@ -94,25 +94,29 @@

```
// build.gradle.kts
implementation("androidx.compose.runtime:runtime-android:1.7.0-rc01")
implementation("androidx.compose.runtime:runtime-android:1.8.0-alpha02")

// build.gradle
implementation 'androidx.compose.runtime:runtime-android:1.7.0-rc01'
implementation 'androidx.compose.runtime:runtime-android:1.8.0-alpha02'

// build.gradle.kts with version catalogs:
implementation(libs.runtime.android)

# libs.versions.toml
[versions]
runtime-android = "1.7.0-rc01"
runtime-android = "1.8.0-alpha02"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
runtime-android = {
module = "androidx.compose.runtime:runtime-android",
version.ref = "runtime-android"
}
```

1.7.0-rc01 is the version this documentation was generated from;
1.8.0-alpha02 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.compose.runtime:runtime-android](androidx_compose_runtime_runtime-android.md.html).
12 changes: 8 additions & 4 deletions docs/checks/AutoboxingStateValueProperty.md.html
Original file line number Diff line number Diff line change
@@ -89,25 +89,29 @@

```
// build.gradle.kts
implementation("androidx.compose.runtime:runtime-android:1.7.0-rc01")
implementation("androidx.compose.runtime:runtime-android:1.8.0-alpha02")

// build.gradle
implementation 'androidx.compose.runtime:runtime-android:1.7.0-rc01'
implementation 'androidx.compose.runtime:runtime-android:1.8.0-alpha02'

// build.gradle.kts with version catalogs:
implementation(libs.runtime.android)

# libs.versions.toml
[versions]
runtime-android = "1.7.0-rc01"
runtime-android = "1.8.0-alpha02"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
runtime-android = {
module = "androidx.compose.runtime:runtime-android",
version.ref = "runtime-android"
}
```

1.7.0-rc01 is the version this documentation was generated from;
1.8.0-alpha02 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.compose.runtime:runtime-android](androidx_compose_runtime_runtime-android.md.html).
14 changes: 9 additions & 5 deletions docs/checks/BadConfigurationProvider.md.html
Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@
Feedback
: https://issuetracker.google.com/issues/new?component=409906
Min
: Lint 7.0
: Lint 8.0 and 8.1
Compiled
: Lint 8.0 and 8.1
Artifact
@@ -96,25 +96,29 @@

```
// build.gradle.kts
implementation("androidx.work:work-runtime:2.10.0-alpha02")
implementation("androidx.work:work-runtime:2.10.0-alpha04")

// build.gradle
implementation 'androidx.work:work-runtime:2.10.0-alpha02'
implementation 'androidx.work:work-runtime:2.10.0-alpha04'

// build.gradle.kts with version catalogs:
implementation(libs.work.runtime)

# libs.versions.toml
[versions]
work-runtime = "2.10.0-alpha02"
work-runtime = "2.10.0-alpha04"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
work-runtime = {
module = "androidx.work:work-runtime",
version.ref = "work-runtime"
}
```

2.10.0-alpha02 is the version this documentation was generated from;
2.10.0-alpha04 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.work:work-runtime](androidx_work_work-runtime.md.html).
14 changes: 9 additions & 5 deletions docs/checks/BadPeriodicWorkRequestEnqueue.md.html
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@
Feedback
: https://issuetracker.google.com/issues/new?component=409906
Min
: Lint 7.0
: Lint 8.0 and 8.1
Compiled
: Lint 8.0 and 8.1
Artifact
@@ -52,25 +52,29 @@

```
// build.gradle.kts
implementation("androidx.work:work-runtime:2.10.0-alpha02")
implementation("androidx.work:work-runtime:2.10.0-alpha04")

// build.gradle
implementation 'androidx.work:work-runtime:2.10.0-alpha02'
implementation 'androidx.work:work-runtime:2.10.0-alpha04'

// build.gradle.kts with version catalogs:
implementation(libs.work.runtime)

# libs.versions.toml
[versions]
work-runtime = "2.10.0-alpha02"
work-runtime = "2.10.0-alpha04"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
work-runtime = {
module = "androidx.work:work-runtime",
version.ref = "work-runtime"
}
```

2.10.0-alpha02 is the version this documentation was generated from;
2.10.0-alpha04 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.work:work-runtime](androidx_work_work-runtime.md.html).
7 changes: 7 additions & 0 deletions docs/checks/BinaryOperationInTimber.md.html
Original file line number Diff line number Diff line change
@@ -39,6 +39,9 @@
Since Timber handles String#format() automatically, use this instead of
String concatenation.

!!! Tip
This lint check has an associated quickfix available in the IDE.

(##) Example

Here is an example of lint warnings produced by this check:
@@ -105,6 +108,10 @@
[versions]
timber = "5.0.1"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
timber = {
module = "com.jakewharton.timber:timber",
version.ref = "timber"
4 changes: 4 additions & 0 deletions docs/checks/BindingReceiverParameter.md.html
Original file line number Diff line number Diff line change
@@ -156,6 +156,10 @@
[versions]
slack-lint-checks = "0.7.4"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
module = "com.slack.lint:slack-lint-checks",
version.ref = "slack-lint-checks"
4 changes: 4 additions & 0 deletions docs/checks/BindingReturnType.md.html
Original file line number Diff line number Diff line change
@@ -113,6 +113,10 @@
[versions]
slack-lint-checks = "0.7.4"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
module = "com.slack.lint:slack-lint-checks",
version.ref = "slack-lint-checks"
4 changes: 4 additions & 0 deletions docs/checks/BindsMustBeAbstract.md.html
Original file line number Diff line number Diff line change
@@ -112,6 +112,10 @@
[versions]
slack-lint-checks = "0.7.4"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
module = "com.slack.lint:slack-lint-checks",
version.ref = "slack-lint-checks"
4 changes: 4 additions & 0 deletions docs/checks/BindsTypeMismatch.md.html
Original file line number Diff line number Diff line change
@@ -121,6 +121,10 @@
[versions]
slack-lint-checks = "0.7.4"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
module = "com.slack.lint:slack-lint-checks",
version.ref = "slack-lint-checks"
4 changes: 4 additions & 0 deletions docs/checks/BindsWrongParameterCount.md.html
Original file line number Diff line number Diff line change
@@ -102,6 +102,10 @@
[versions]
slack-lint-checks = "0.7.4"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
module = "com.slack.lint:slack-lint-checks",
version.ref = "slack-lint-checks"
3 changes: 3 additions & 0 deletions docs/checks/BomWithoutPlatform.md.html
Original file line number Diff line number Diff line change
@@ -34,6 +34,9 @@
When including a BOM, the dependency's coordinates must be wrapped in a
call to `platform()` for Gradle to interpret it correctly.

!!! Tip
This lint check has an associated quickfix available in the IDE.

(##) Example

Here is an example of lint warnings produced by this check:
4 changes: 4 additions & 0 deletions docs/checks/CastingViewContextToActivity.md.html
Original file line number Diff line number Diff line change
@@ -66,6 +66,10 @@
[versions]
slack-lint-checks = "0.7.4"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
module = "com.slack.lint:slack-lint-checks",
version.ref = "slack-lint-checks"
4 changes: 4 additions & 0 deletions docs/checks/ColorCasing.md.html
Original file line number Diff line number Diff line change
@@ -88,6 +88,10 @@
[versions]
lint-rules-android = "0.25.0"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
lint-rules-android = {
module = "com.vanniktech:lint-rules-android",
version.ref = "lint-rules-android"
Loading
Loading