Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 09238b3

Browse files
authored
Merge pull request #1 from tnorbye/gh-pages
Add docs
2 parents 31f7db9 + 9b6e2b9 commit 09238b3

25 files changed

+8635
-0
lines changed

‎README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
Custom Lint Rules
22
=================
33

4+
The lint source code contains a lot of documentation on how to write
5+
custom checks; this git repository contains a snapshot of this
6+
documentation which you can read here:
7+
8+
* [Full API Guide](https://tnorbye.github.io/android-custom-lint-rules/book.html)
9+
* [Other docs](https://tnorbye.github.io/android-custom-lint-rules/index.html)
10+
11+
Lint
12+
----
13+
414
The [Android `lint` tool](http://developer.android.com/tools/help/lint.html) is a static code
515
analysis tool that checks your project source files for potential bugs and optimization
616
improvements for correctness, security, performance, usability, accessibility, and

‎docs/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
markdeep.min.js
2+
todo.md
3+
blank.md.html
4+
spell-check.sh
5+
spelling-ok.txt

‎docs/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Android Lint
2+
============
3+
4+
(Note that many files in this docs folder has the extension `.md.html`
5+
instead of just `.md`. That means that they can be opened in a
6+
browser for better visualization (such as syntax highlighting of code
7+
snippets) but are readable and editable as markdown.)
8+
9+
Let's go there right now: [Link](README.md.html)
10+
11+
There is also a pre-rendered HTML version of the API Guide
12+
[here](book.html) suitable for online hosting.

‎docs/README.md.html‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Android Lint
2+
============
3+
4+
Android Lint is a static analysis tool (which despite the name is not
5+
limited to Android, and within Google for example is used to analyze
6+
Java and Kotlin server side code as well as Android and even desktop
7+
software like IDEs.)
8+
9+
Lint's focus is on finding bugs (whether they are related to
10+
correctness, performance, security, internationalization, usability and
11+
so on); it's not a source code style checker.
12+
13+
Available documentation:
14+
15+
* [Lint Features](features.md.html)
16+
* [Recent Changes](changes.md.html)
17+
* Documents for users of lint, in the `usage` folder:
18+
- [How to suppress incidents](usage/suppressing.md.html)
19+
- [How to use baselines](usage/baselines.md.html)
20+
- [How to use `lint.xml` files](usage/lintxml.md.html)
21+
- [Environment variables and properties](usage/variables.md.html)
22+
* Documents for authors of additional lint checks, in the
23+
`api-guide` folder:
24+
- [Complete Book](book.md.html), containing all of the below
25+
documents as chapters, suitable for offline reading
26+
- [Basics](api-guide/basics.md.html)
27+
- [A Sample Lint Check](api-guide/example.md.html)
28+
- [Publishing a Lint check](api-guide/publishing.md.html)
29+
- [Unit Testing](api-guide/unit-testing.md.html)
30+
- [Adding Quick Fixes](api-guide/quickfixes.md.html)
31+
- [Terminology](api-guide/terminology.md.html)
32+
- [Partial analysis](api-guide/partial-analysis.md.html)
33+
- [Frequently Asked Questions](api-guide/faq.md.html)
34+
* Documents for lint internals, intended for developers of lint
35+
itself, in the `internal` folder:
36+
- [Guidelines](internal/guidelines.md.html)
37+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38+
39+
Documentation History:
40+
* March 2021: Initial version
41+
42+
<!-- 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>

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /