Skip to content

Commit 0424f7e

Browse files
Fix dangling Javadoc comments, also fixes Javadoc not getting picked up.
1 parent c6e92a6 commit 0424f7e

File tree

7 files changed

+12
-9
lines changed

7 files changed

+12
-9
lines changed

objectbox-java-api/src/main/java/io/objectbox/annotation/NotNull.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@
3030
*/
3131
@Retention(RetentionPolicy.CLASS)
3232
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
33-
/** TODO public */ @interface NotNull {
33+
/* TODO public */ @interface NotNull {
3434
}

objectbox-java-api/src/main/java/io/objectbox/annotation/OrderBy.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
*/
2929
@Retention(RetentionPolicy.CLASS)
3030
@Target(ElementType.FIELD)
31-
/** TODO public */ @interface OrderBy {
31+
/* TODO public */ @interface OrderBy {
3232
/**
3333
* Comma-separated list of properties, e.g. "propertyA, propertyB, propertyC"
3434
* To specify direction, add ASC or DESC after property name, e.g.: "propertyA DESC, propertyB ASC"

objectbox-java/src/main/java/io/objectbox/Box.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
import java.lang.reflect.Field;
2020
import java.util.ArrayList;
2121
import java.util.Collection;
22-
import java.util.Collections;
2322
import java.util.HashMap;
2423
import java.util.Iterator;
2524
import java.util.List;
@@ -443,8 +442,10 @@ public void remove(@Nullable long... ids) {
443442
}
444443
}
445444

445+
/**
446+
* @deprecated use {@link #removeByIds(Collection)} instead.
447+
*/
446448
@Deprecated
447-
/** @deprecated use {@link #removeByIds(Collection)} instead. */
448449
public void removeByKeys(@Nullable Collection<Long> ids) {
449450
removeByIds(ids);
450451
}

objectbox-java/src/main/java/io/objectbox/BoxStoreBuilder.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ private BoxStoreBuilder() {
104104
model = null;
105105
}
106106

107-
@Internal
108107
/** Called internally from the generated class "MyObjectBox". Check MyObjectBox.builder() to get an instance. */
108+
@Internal
109109
public BoxStoreBuilder(byte[] model) {
110110
this.model = model;
111111
if (model == null) {
@@ -295,8 +295,10 @@ public BoxStoreBuilder maxSizeInKByte(long maxSizeInKByte) {
295295
return this;
296296
}
297297

298+
/**
299+
* @deprecated Use {@link #debugFlags} instead.
300+
*/
298301
@Deprecated
299-
/** @deprecated Use {@link #debugFlags} instead. */
300302
public BoxStoreBuilder debugTransactions() {
301303
this.debugFlags |= DebugFlags.LOG_TRANSACTIONS_READ | DebugFlags.LOG_TRANSACTIONS_WRITE;
302304
return this;

objectbox-java/src/main/java/io/objectbox/Factory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
import io.objectbox.annotation.apihint.Experimental;
2020

2121

22-
@Experimental
2322
/**
2423
* Generic Factory that provides a resource on demand (if and when it is required).
2524
*/
25+
@Experimental
2626
public interface Factory<T> {
2727
T provide() throws Exception;
2828
}

objectbox-java/src/main/java/io/objectbox/model/IdUid.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
import java.util.*;
2424
import com.google.flatbuffers.*;
2525

26-
@SuppressWarnings("unused")
2726
/**
2827
* ID tuple: besides the main ID there is also a UID for verification
2928
*/
29+
@SuppressWarnings("unused")
3030
public final class IdUid extends Struct {
3131
public void __init(int _i, ByteBuffer _bb) { bb_pos = _i; bb = _bb; }
3232
public IdUid __assign(int _i, ByteBuffer _bb) { __init(_i, _bb); return this; }

objectbox-java/src/main/java/io/objectbox/model/Model.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@
2323
import java.util.*;
2424
import com.google.flatbuffers.*;
2525

26-
@SuppressWarnings("unused")
2726
/**
2827
* A model describes all entities and other meta data.
2928
* The current model of an app is synced against ObjectBox's persisted schema.
3029
* The model itself is not persisted, and thus may change as long as both ends are consistent (Java and native).
3130
* There could be multiple models/schemas (one dbi per schema) in the future.
3231
*/
32+
@SuppressWarnings("unused")
3333
public final class Model extends Table {
3434
public static Model getRootAsModel(ByteBuffer _bb) { return getRootAsModel(_bb, new Model()); }
3535
public static Model getRootAsModel(ByteBuffer _bb, Model obj) { Constants.FLATBUFFERS_1_11_1(); _bb.order(ByteOrder.LITTLE_ENDIAN); return (obj.__assign(_bb.getInt(_bb.position()) + _bb.position(), _bb)); }

0 commit comments

Comments
 (0)