Skip to content

Commit f76c9d8

Browse files
API docs: fix various warnings #259
- empty <p> tag - unescaped HTML characters - not a warning, but add a missing space
1 parent caf0641 commit f76c9d8

File tree

5 files changed

+4
-6
lines changed

5 files changed

+4
-6
lines changed

objectbox-java/src/main/java/io/objectbox/relation/ToMany.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
* <pre>{@code
5959
* // Java
6060
* @Entity
61-
* public class Student{
61+
* public class Student {
6262
* private ToMany<Teacher> teachers;
6363
* }
6464
*
@@ -85,7 +85,6 @@
8585
* <p>
8686
* To apply (persist) the changes to the database, call {@link #applyChangesToDb()} or put the object with the ToMany.
8787
* For important details, see the notes about relations of {@link Box#put(Object)}.
88-
* <p>
8988
* <pre>{@code
9089
* // Example 1: add target objects to a relation
9190
* student.getTeachers().add(teacher1);

objectbox-java/src/main/java/io/objectbox/relation/ToOne.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@
6161
* </ul>
6262
* <p>
6363
* Then, to persist the changes {@link Box#put} the object with the ToOne.
64-
* <p>
6564
* <pre>{@code
6665
* // Example 1: create a relation
6766
* order.getCustomer().setTarget(customer);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public static boolean isServerAvailable() {
4444
}
4545

4646
/**
47-
* Returns true if the included native (JNI) ObjectBox library supports Sync hybrids (server & client).
47+
* Returns true if the included native (JNI) ObjectBox library supports Sync hybrids (server and client).
4848
*/
4949
public static boolean isHybridAvailable() {
5050
return isAvailable() && isServerAvailable();

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
public final class SyncFlags {
2626
private SyncFlags() { }
2727
/**
28-
* Enable (rather extensive) logging on how IDs are mapped (local <-> global)
28+
* Enable (rather extensive) logging on how IDs are mapped (local &lt;-&gt; global)
2929
*/
3030
public static final int DebugLogIdMapping = 1;
3131
/**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/**
2525
* Combines the functionality of a Sync client and a Sync server.
2626
* <p>
27-
* It is typically used in local cluster setups, in which a "hybrid" functions as a client & cluster peer (server).
27+
* It is typically used in local cluster setups, in which a "hybrid" functions as a client and cluster peer (server).
2828
* <p>
2929
* Call {@link #getStore()} to retrieve the store. To set sync listeners use the {@link SyncClient} that is available
3030
* from {@link #getClient()}.

0 commit comments

Comments
 (0)