From 0953bf376d1449e710662e427dfe7423e936dad1 Mon Sep 17 00:00:00 2001 From: Evan Tschannen Date: Fri, 25 Oct 2019 13:38:04 -0700 Subject: [PATCH] fixed Javadoc headings --- bindings/java/src/main/com/apple/foundationdb/FDB.java | 6 +++--- .../java/src/main/com/apple/foundationdb/tuple/Tuple.java | 4 ++-- bindings/java/src/main/overview.html.in | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/bindings/java/src/main/com/apple/foundationdb/FDB.java b/bindings/java/src/main/com/apple/foundationdb/FDB.java index e20fa90432..621417256d 100644 --- a/bindings/java/src/main/com/apple/foundationdb/FDB.java +++ b/bindings/java/src/main/com/apple/foundationdb/FDB.java @@ -30,7 +30,7 @@ import java.util.concurrent.atomic.AtomicInteger; /** * The starting point for accessing FoundationDB. *
- *

Setting API version

+ *

Setting API version

* The FoundationDB API is accessed with a call to {@link #selectAPIVersion(int)}. * This call is required before using any other part of the API. The call allows * an error to be thrown at this point to prevent client code from accessing a later library @@ -49,11 +49,11 @@ import java.util.concurrent.atomic.AtomicInteger; * being used to connect to the cluster. In particular, you should not advance * the API version of your application after upgrading your client until the * cluster has also been upgraded.
- *

Getting a database

+ *

Getting a database

* Once the API version has been set, the easiest way to get a {@link Database} object to use is * to call {@link #open}. *
- *

Client networking

+ *

Client networking

* The network is started either implicitly with a call to a variant of {@link #open()} * or started explicitly with a call to {@link #startNetwork()}. *
diff --git a/bindings/java/src/main/com/apple/foundationdb/tuple/Tuple.java b/bindings/java/src/main/com/apple/foundationdb/tuple/Tuple.java index e5556faaa6..70dde8d2b5 100644 --- a/bindings/java/src/main/com/apple/foundationdb/tuple/Tuple.java +++ b/bindings/java/src/main/com/apple/foundationdb/tuple/Tuple.java @@ -39,7 +39,7 @@ import com.apple.foundationdb.Range; * the same order in which they would sort in FoundationDB. {@code Tuple}s sort * first by the first element, then by the second, etc. This makes the tuple layer * ideal for building a variety of higher-level data models.
- *

Types

+ *

Types

* A {@code Tuple} can * contain byte arrays ({@code byte[]}), {@link String}s, {@link Number}s, {@link UUID}s, * {@code boolean}s, {@link List}s, {@link Versionstamp}s, other {@code Tuple}s, and {@code null}. @@ -50,7 +50,7 @@ import com.apple.foundationdb.Range; * a {@code long} integral value, so the range will be constrained to * [{@code -2^63}, {@code 2^63-1}]. Note that for numbers outside this range the way that Java * truncates integral values may yield unexpected results.
- *

{@code null} values

+ *

{@code null} values

* The FoundationDB tuple specification has a special type-code for {@code None}; {@code nil}; or, * as Java would understand it, {@code null}. * The behavior of the layer in the presence of {@code null} varies by type with the intention diff --git a/bindings/java/src/main/overview.html.in b/bindings/java/src/main/overview.html.in index d594b769e3..648a4e3478 100644 --- a/bindings/java/src/main/overview.html.in +++ b/bindings/java/src/main/overview.html.in @@ -2,7 +2,7 @@ This documents the client API for using FoundationDB from Java.

-

Installation

+

Installation

FoundationDB's Java bindings rely on native libraries that are installed as part of the FoundationDB client binaries installation (see @@ -10,7 +10,7 @@ Installing FoundationDB client binaries). The JAR can be downloaded from our website and then added to your classpath.

-

Getting started

+

Getting started

To start using FoundationDB from Java, create an instance of the {@link com.apple.foundationdb.FDB FoundationDB API interface} with the version of the API that you want to use (this release of the FoundationDB Java API supports versions between {@code 510} and {@code 620}). @@ -50,7 +50,7 @@ public class Example { } } -

FoundationDB {@link com.apple.foundationdb.tuple Tuple API}

+

FoundationDB {@link com.apple.foundationdb.tuple Tuple API}

The {@link com.apple.foundationdb.tuple Tuple API} is provided with the core Java API for FoundationDB. This layer is provided in some form in all official language bindings. It enables cross-language support for storing and retrieving typed data from the @@ -60,7 +60,7 @@ binary data that FoundationDB supports. And, just as importantly, data packed in and general Tuple documentation for information about how Tuples sort and can be used to efficiently model data.
-

FoundationDB {@link com.apple.foundationdb.directory Directory API}

+

FoundationDB {@link com.apple.foundationdb.directory Directory API}

The {@link com.apple.foundationdb.directory Directory API} is provided with the core Java API for FoundationDB. This layer is provided in some form in all official language bindings. The FoundationDB API provides directories as a tool for