diff --git a/build.gradle b/build.gradle index c6c763fc..1e01b240 100644 --- a/build.gradle +++ b/build.gradle @@ -44,7 +44,7 @@ archivesBaseName = "${mod_name}-MC${minecraft_version}" sourceCompatibility = targetCompatibility = JavaVersion.VERSION_1_8 compileJava.sourceCompatibility = compileJava.targetCompatibility = JavaVersion.VERSION_1_8 -javadoc.options.addStringOption('Xdoclint:none', '-quiet') +//javadoc.options.addStringOption('Xdoclint:none', '-quiet') configurations { embed diff --git a/src/main/java/li/cil/oc2/api/API.java b/src/main/java/li/cil/oc2/api/API.java index 0d547666..f611c38b 100644 --- a/src/main/java/li/cil/oc2/api/API.java +++ b/src/main/java/li/cil/oc2/api/API.java @@ -16,7 +16,7 @@ public final class API { *
* Example: *
- * InterModComms.sendTo(API.MOD_ID, API.IMC_ADD_DEVICE_PROVIDER, () -> new DeviceProvider() { ... });
+ * InterModComms.sendTo(API.MOD_ID, API.IMC_ADD_DEVICE_PROVIDER, () -> new DeviceProvider() { ... });
*
*/
public static final String IMC_ADD_DEVICE_PROVIDER = "addDeviceProvider";
diff --git a/src/main/java/li/cil/oc2/api/bus/Device.java b/src/main/java/li/cil/oc2/api/bus/Device.java
index 8a6c8851..01829e1e 100644
--- a/src/main/java/li/cil/oc2/api/bus/Device.java
+++ b/src/main/java/li/cil/oc2/api/bus/Device.java
@@ -7,7 +7,7 @@ package li.cil.oc2.api.bus;
* managing the bus.
*
* Note that it is strongly encouraged for implementations to provide an overloaded
- * {@link #equals(Object)} and {@link #hashCode()} so that identical devices can be
+ * {@link Object#equals(Object)} and {@link Object#hashCode()} so that identical devices can be
* detected.
*/
public interface Device {
diff --git a/src/main/java/li/cil/oc2/api/bus/device/object/Callback.java b/src/main/java/li/cil/oc2/api/bus/device/object/Callback.java
index f8ed367e..9df36c1a 100644
--- a/src/main/java/li/cil/oc2/api/bus/device/object/Callback.java
+++ b/src/main/java/li/cil/oc2/api/bus/device/object/Callback.java
@@ -29,16 +29,22 @@ public @interface Callback {
* Use this when the targeted method interacts with data that is not thread
* safe, for example the world or any objects inside the world, such as
* tile entities and entities.
+ *
+ * @return {@code true} when to be executed on main thread; {@code false} otherwise.
*/
boolean synchronize() default true;
/**
* Option VM visible documentation of this method.
+ *
+ * @return the description of the method.
*/
String description() default "";
/**
* Optional VM visible documentation of the values returned by this method.
+ *
+ * @return the description of the return value.
*/
String returnValueDescription() default "";
}
diff --git a/src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java b/src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java
index a44b5d64..a480772c 100644
--- a/src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java
+++ b/src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java
@@ -38,7 +38,7 @@ public final class Callbacks {
* public void f(String a) { }
* }
*
- * List
* In a more general sense, these can be considered tags the device can be
* referenced by inside a VM.
+ *
+ * @return the list of type names.
*/
List
* May be used inside VMs to generate documentation.
+ *
+ * @return the method description.
*/
default Optional
* May be used inside VMs to generate documentation.
+ *
+ * @return the return value description.
*/
default Optional
* May be used inside VMs to generate documentation.
+ *
+ * @return the name of the parameter.
*/
default Optional
* May be used inside VMs to generate documentation.
+ *
+ * @return the description of the parameter.
*/
default Optional
* Failing that, implementations should return instances that are equal to each
- * other when compared using {@link #equals(Object)} and have equal {@link #hashCode()}s.
+ * other when compared using {@link Object#equals(Object)} and have equal {@link Object#hashCode()}s.
*
* This is required to avoid device duplication when a device is connected to a bus more
* than once (e.g. for blocks when connected cables are adjacent to multiple faces of the