Skip to content

docs: fix SharedPreferences typos in KDoc comments #13

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

Open
Avicennasis wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix SharedPreferences typos in KDoc comments #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion annotations/src/main/java/com/glassdoor/preferencex/annotations/Preference.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ package com.glassdoor.preferencex.annotations
annotation class Preference(
/**
* The default integer value that will be used
* when getting the value from the SharedPReferences.
* when getting the value from the SharedPreferences.
* If no value is specified, it will default to `0`
*/
val defaultInt: Int = 0,
Expand Down
4 changes: 2 additions & 2 deletions annotations/src/main/java/com/glassdoor/preferencex/annotations/PreferenceFile.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ package com.glassdoor.preferencex.annotations
* `SharedPreferences` which is passed around through Dependency
* Injection. In these cases, it's more valuable to generate
* extensions on the wrapper than `SharedPreferences` itself.
* You can do that by simply annotating your SharedPreference
* You can do that by simply annotating your SharedPreferences
* instance with @PreferenceFile. For example:
* ```
* class CustomWrapper(application: Application) {
Expand All @@ -49,7 +49,7 @@ annotation class PreferenceFile(
* of SharedPreferences (presumably for multiple files of
* SharedPreferences), you should specify the `fileName`
* so that PreferenceX can generate the appropriate
* extensions on the appropriate SharedPreference instance.
* extensions on the appropriate SharedPreferences instance.
* For example:
* ```
* @PreferenceFile(fileName = "startup")
Expand Down