Add javadoc for handshakeKeys flag.

2026-02-13 11:19:04 +01:00 · 2019-04-23 16:26:13 +01:00
parent 8b2b7599f9
commit 251eb9e712
1 changed files with 3 additions and 0 deletions
--- a/bramble-api/src/main/java/org/briarproject/bramble/api/identity/AuthorFactory.java
+++ b/bramble-api/src/main/java/org/briarproject/bramble/api/identity/AuthorFactory.java
@@ -19,6 +19,9 @@ public interface AuthorFactory {
 	/**
 	 * Creates a local author with the current format version and the given
 	 * name.
+	 *
+	 * @param handshakeKeys true if the local author should include handshake
+	 * keys.
 	 */
 	LocalAuthor createLocalAuthor(String name, boolean handshakeKeys);
 }