From 9763a61a226050996b4fbdbc53c600fdb8014c3c Mon Sep 17 00:00:00 2001 From: Alex Miller Date: Mon, 19 Mar 2018 13:12:42 -0700 Subject: [PATCH 1/2] Fix broken links in pointing to cluster file documentation. --- .../src/main/com/apple/foundationdb/FDB.java | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/bindings/java/src/main/com/apple/foundationdb/FDB.java b/bindings/java/src/main/com/apple/foundationdb/FDB.java index ffc159a308..7b345edb7c 100644 --- a/bindings/java/src/main/com/apple/foundationdb/FDB.java +++ b/bindings/java/src/main/com/apple/foundationdb/FDB.java @@ -180,7 +180,7 @@ public class FDB { /** * Connects to the cluster specified by the - * default fdb.cluster file. + * default fdb.cluster file. * If the FoundationDB network has not been started, it will be started in the course of this call * as if {@link FDB#startNetwork()} had been called. * @@ -199,9 +199,9 @@ public class FDB { * {@link #startNetwork()} had been called. * * @param clusterFilePath the - * cluster file + * cluster file * defining the FoundationDB cluster. This can be {@code null} if the - * default fdb.cluster file + * default fdb.cluster file * is to be used. * * @return a {@code CompletableFuture} that will be set to a FoundationDB {@code Cluster}. @@ -220,9 +220,9 @@ public class FDB { * are produced from using the resulting {@link Cluster}. * * @param clusterFilePath the - * cluster file + * cluster file * defining the FoundationDB cluster. This can be {@code null} if the - * default fdb.cluster file + * default fdb.cluster file * is to be used. * @param e used to run the FDB network thread * @@ -245,7 +245,7 @@ public class FDB { /** * Initializes networking, connects with the - * default fdb.cluster file, + * default fdb.cluster file, * and opens the database. * * @return a {@code CompletableFuture} that will be set to a FoundationDB {@link Database} @@ -259,9 +259,9 @@ public class FDB { * and opens the database. * * @param clusterFilePath the - * cluster file + * cluster file * defining the FoundationDB cluster. This can be {@code null} if the - * default fdb.cluster file + * default fdb.cluster file * is to be used. * * @return a {@code CompletableFuture} that will be set to a FoundationDB {@link Database} @@ -275,9 +275,9 @@ public class FDB { * and opens the database. * * @param clusterFilePath the - * cluster file + * cluster file * defining the FoundationDB cluster. This can be {@code null} if the - * default fdb.cluster file + * default fdb.cluster file * is to be used. * @param e the {@link Executor} to use to execute asynchronous callbacks * From a975cb82e7cee3f2b1efec926c0fff045eda1fb3 Mon Sep 17 00:00:00 2001 From: Alex Miller Date: Mon, 19 Mar 2018 13:42:42 -0700 Subject: [PATCH 2/2] Fix other broken links in java docs. --- bindings/java/src/main/overview.html.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bindings/java/src/main/overview.html.in b/bindings/java/src/main/overview.html.in index 6e064b40bb..5127b460c1 100644 --- a/bindings/java/src/main/overview.html.in +++ b/bindings/java/src/main/overview.html.in @@ -5,7 +5,7 @@ This documents the client API for using FoundationDB from Java.

Installation

FoundationDB's Java bindings rely on native libraries that are installed as part of the FoundationDB client binaries installation (see - + Installing FoundationDB client binaries). The FoundationDB Java bindings are available through Artifactory. To use them in your Maven-enabled project, add a dependency to your pom.xml like:
@@ -30,7 +30,7 @@ With this API object you can then open {@link com.apple.foundationdb.Cluster Clu {@link com.apple.foundationdb.Database Database}s and start using {@link com.apple.foundationdb.Transaction Transaction}s. Here we give an example. The example relies on a cluster file at the -default location +default location for your platform and a running server.