Skip to content

Commit bb3696f

Browse files
committed
Improve Javadoc
1 parent 03d747f commit bb3696f

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/main/java/org/cryptomator/integrations/keychain/KeychainAccessProvider.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ public interface KeychainAccessProvider {
2525
* Associates a passphrase with a given key and a name for that key.
2626
*
2727
* @param key Key used to retrieve the passphrase via {@link #loadPassphrase(String)}.
28-
* @param displayName The according name to the key.
28+
* @param displayName The according name to the key. That's the name of the vault displayed in the UI.
29+
* It's passed to the keychain as an additional information about the vault besides the key.
30+
* The parameter does not need to be unique or be checked by the keychain.
2931
* @param passphrase The secret to store in this keychain.
3032
* @throws KeychainAccessException If storing the password failed
3133
*/
@@ -61,7 +63,9 @@ default void storePassphrase(String key, String displayName, CharSequence passph
6163
* Updates a passphrase with a given key and stores a name for that key. Noop, if there is no item for the given key.
6264
*
6365
* @param key Unique key previously used while {@link #storePassphrase(String, CharSequence) storing a passphrase}.
64-
* @param displayName The according name to the key.
66+
* @param displayName The according name to the key. That's the name of the vault displayed in the UI.
67+
* It's passed to the keychain as an additional information about the vault besides the key.
68+
* The parameter does not need to be unique or be checked by the keychain.
6569
* @param passphrase The secret to be updated in this keychain.
6670
* @throws KeychainAccessException If changing the password failed
6771
*/

0 commit comments

Comments
 (0)