SyncServerBuilder: document existing parameters

Author: greenrobot-team

objectbox-java/src/main/java/io/objectbox/sync/Sync.java

@@ -17,6 +17,7 @@
 package io.objectbox.sync;
 
 import io.objectbox.BoxStore;
+import io.objectbox.sync.server.SyncServer;
 import io.objectbox.sync.server.SyncServerBuilder;
 
 /**
@@ -50,12 +51,15 @@ public static SyncBuilder client(BoxStore boxStore, String url, SyncCredentials
     }
 
     /**
-     * Start building a sync server. Requires the BoxStore the server should use,
-     * the URL and port the server should bind to and authenticator credentials to authenticate clients.
-     * Additional authenticator credentials can be supplied using the builder.
-     * <p>
-     * For the embedded server, currently only {@link SyncCredentials#sharedSecret} and {@link SyncCredentials#none}
-     * are supported.
+     * Starts building a {@link SyncServer}. Once done, complete with {@link SyncServerBuilder#build() build()}.
+     *
+     * @param boxStore The {@link BoxStore} the server should use.
+     * @param url The URL of the Sync server on which the Sync protocol is exposed. This is typically a WebSockets URL
+     * starting with {@code ws://} or {@code wss://} (for encrypted connections), for example
+     * {@code ws://0.0.0.0:9999}.
+     * @param authenticatorCredentials A list of enabled authentication methods available to Sync clients. Additional
+     * authenticator credentials can be supplied using the builder. For the embedded server, currently only
+     * {@link SyncCredentials#sharedSecret} and {@link SyncCredentials#none} are supported.
      */
     public static SyncServerBuilder server(BoxStore boxStore, String url, SyncCredentials authenticatorCredentials) {
         return new SyncServerBuilder(boxStore, url, authenticatorCredentials);

objectbox-java/src/main/java/io/objectbox/sync/server/SyncServerBuilder.java

@@ -25,6 +25,7 @@
 import io.objectbox.annotation.apihint.Experimental;
 import io.objectbox.flatbuffers.FlatBufferBuilder;
 import io.objectbox.sync.Credentials;
+import io.objectbox.sync.Sync;
 import io.objectbox.sync.SyncCredentials;
 import io.objectbox.sync.SyncCredentialsToken;
 import io.objectbox.sync.listener.SyncChangeListener;
@@ -46,6 +47,9 @@ public class SyncServerBuilder {
     private final List<ClusterPeerInfo> clusterPeers = new ArrayList<>();
     private int clusterFlags;
 
+    /**
+     * Use {@link Sync#server(BoxStore, String, SyncCredentials)} instead.
+     */
     public SyncServerBuilder(BoxStore boxStore, String url, SyncCredentials authenticatorCredentials) {
         checkNotNull(boxStore, "BoxStore is required.");
         checkNotNull(url, "Sync server URL is required.");