mirror/Anki-Android
0
0
Fork 0
mirror of https://github.com/ankidroid/Anki-Android.git synced 2024-09-19 11:32:15 +02:00
Code

[Clean Up] annotations README.md (#15633)

Browse Source 
* fix warning of unexpected end of file

* Update README.md

* Update README.md
This commit is contained in:
Rohit Raj 2024-02-29 23:31:46 +05:30 committed by GitHub
parent fc3f3bf7e6
commit a94f8355d5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
annotations/README.md
View File

@ -2,7 +2,7 @@
## Rationale
`@Contract` annotations for Android methods allow the removal of tautotlogical lint checks.
`@Contract` annotations for Android methods allow the removal of tautological lint checks.
For example: if `TextUtils.isEmpty(str)` returns `false`, then `str` is non-null. `@Contract` allows us to specify this invariant to the linter, which reduces lint warnings and/or unnecessary code.
@ -22,11 +22,11 @@ See: https://www.jetbrains.com/help/idea/contract-annotations.html
Annotations should now appear
## Modificiation Instructions
## Modification Instructions
* In Android Studio Settings: `jdk.table.xml`
* You can find the element under one of the `<jdk>` elements as a `file://` URL:
* Removing this line will allow the selection of another annotations root.
* You can find the element under one of the `<jdk>` elements as a `file://` URL:
* Removing this line will allow the selection of another annotation root.
Sample:
```xml
@ -46,4 +46,4 @@ Sample:
It would be ideal if these could be set on a per-project basis. I haven't had the time to determine whether this is possible.
These annotations are not yet supported by our automated tooling.
These annotations are not yet supported by our automated tooling.