Skip to content

Snapshot5 #49

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 2 commits into from
Jun 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,5 @@ snippets) but are readable and editable as markdown.)

Let's go there right now: [Link](README.md.html)

There is also a pre-rendered HTML version of the API Guide
[here](book.html) suitable for online hosting.

Finally, a (usually recent) snapshot of these docs are hosted
A (usually recent) snapshot of these docs are hosted
[here](http://googlesamples.github.io/android-custom-lint-rules/).
14 changes: 11 additions & 3 deletions docs/README.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,23 @@
* Documents for users of lint, in the `usage` folder:
- [Complete Book](user-guide.md.html), containing all of the below
documents as chapters, suitable for offline reading
- [Issue documentation](checks/index.md.html) which lists all the
available checks and provides documentation for each one.
- [Issue documentation](https://googlesamples.github.io/android-custom-lint-rules/checks/index.md.html)
which lists all the available checks and provides documentation
for each one.
- [Performance Tuning Tips](usage/performance-tuning.md.html)
- [How to suppress incidents](usage/suppressing.md.html)
- [How to use baselines](usage/baselines.md.html)
- [How to use `lint.xml` files](usage/lintxml.md.html)
- [Gradle plugin DSL](usage/agp-dsl.md.html)
- [Lint command line](usage/flags.md.html)
- [Environment variables and properties](usage/variables.md.html)
* Documents for authors of additional lint checks, in the
`api-guide` folder:
- [Complete Book](api-guide.md.html), containing all of the below
documents as chapters, suitable for offline reading
- [Basics](api-guide/basics.md.html)
- [A Sample Lint Check](api-guide/example.md.html)
- [Analyzing data flow](api-guide/dataflow-analyzer.md.html)
- [Publishing a Lint check](api-guide/publishing.md.html)
- [Unit Testing](api-guide/unit-testing.md.html)
- [Adding Quick Fixes](api-guide/quickfixes.md.html)
Expand All @@ -44,7 +48,11 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Documentation History:
* May 2021: Adding documentation for individual lint issues
* June 2021: Added documentation for the
[dataflow analyzer](api-guide/dataflow-analyzer.md.html),
[Lint Gradle DSL](usage/agp-dsl.md.html) and
[command line flags](usage/flags.md.html).
* May 2021: Added documentation for individual lint issues
* March 2021: Initial version

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>
591 changes: 536 additions & 55 deletions docs/api-guide.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/api-guide.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
(insert api-guide/unit-testing.md.html here)
(insert api-guide/quickfixes.md.html here)
(insert api-guide/partial-analysis.md.html here)
(insert api-guide/dataflow-analyzer.md.html here)
(insert api-guide/faq.md.html here)

# Appendix: Recent Changes
Expand Down
17 changes: 17 additions & 0 deletions docs/api-guide/changes.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,21 @@
* For quickfixes, the `independent` property had inverted logic;
this has now been reversed to follow the meaning of the name.

* The location range returned when looking up the location for a call
will now include arguments outside of the call range itself. This is
important when the code is using Kotlin's assignment syntax for
calling methods as if they are properties.

* Lint's unit testing framework now checks all `import` statements in
test files to make sure that they resolve. This will help catch
common bugs and misunderstandings where tests reference frameworks
that aren't available to lint in the unit test, and where you need to
either add the library or more commonly just add some simple stubs.
If the import statements do not matter to the test, you can just mark
the test as allowing compilation errors, using
`.allowCompilationErrors()` on the `lint()` task.

* The [data flow analyzer](dataflow-analyzer.md.html) has been
significantly improved, particularly around Kotlin scoping functions.

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>
Loading