Skip to content

Commit

Permalink
Removed library-only constructor restriction for KspConfig
Browse files Browse the repository at this point in the history
  • Loading branch information
cioccarellia committed Feb 28, 2024
1 parent 126e80e commit 1c709e9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ It offers a consistent syntax for reading and writing values, whilst parameteriz
## Design
The library is built with different stages in mind, each taking input from the previous one:

1. The KsPrefs API allows developers to interface with the SharedPreferences APIs primitives: `getString`, `setInt`
1. The KsPrefs API allows developers to interface with the main primitives: `pull` and `push`, to read and write values to the storage, respectively;
2.

``` mermaid
graph LR
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import java.nio.charset.Charset
/**
* Global KsPrefs config object
* */
data class KspConfig @RestrictTo(RestrictTo.Scope.LIBRARY) constructor(
data class KspConfig(
@IntRange(from = 0x0000, to = 0x0010)
var mode: Int = Defaults.MODE,
var charset: Charset = Defaults.CHARSET,
Expand Down

0 comments on commit 1c709e9

Please sign in to comment.