Some documentation improvements.

This commit is contained in:
Florian Nücke
2022-01-07 07:48:40 +01:00
parent 23d41a0b48
commit 94e57af093
4 changed files with 13 additions and 5 deletions

View File

@@ -18,7 +18,7 @@ import java.util.UUID;
* connected to this element.
* <p>
* This interface is relevant when implementing means to extend the bus, e.g.
* to provide a custom cable implementation or some kind of a device container.
* to provide a custom cable implementation or some kind of device container.
* <p>
* Implementations <em>must</em> call {@link #scheduleScan()} when they become
* invalid, e.g. due to being in a chunk that is being unloaded or the block
@@ -31,7 +31,7 @@ public interface DeviceBusElement extends DeviceBus {
* <p>
* This will be called by {@link DeviceBusController}s when scanning.
* <p>
* Bus elements can be have multiple controllers at the same time. This is used
* Bus elements can have multiple controllers at the same time. This is used
* by controllers to detect each other on the bus.
* <p>
* When {@link #scheduleScan()} is called, {@link DeviceBusController#scheduleBusScan()}
@@ -89,7 +89,7 @@ public interface DeviceBusElement extends DeviceBus {
* track of the device. Note that some device types (e.g. {@link RPCDevice}s)
* require for an ID to be provided for them to work at all.
* <p>
* It is possible for multiple devices to have the same identifier. Typically
* It is possible for multiple devices to have the same identifier. Typically,
* this means they represent a view on the same underlying object. How this is
* handled depends on the device type and may or may not be supported.
* <p>

View File

@@ -31,7 +31,7 @@ public interface Firmware extends IForgeRegistryEntry<Firmware> {
* <p>
* This will usually load machine code into memory at the specified start address.
* <p>
* Typically only returns {@code false} when there was not enough memory to fit the firmware.
* Typically, only returns {@code false} when there was not enough memory to fit the firmware.
*
* @param memory access to the memory map of the machine.
* @param startAddress the memory address where execution will commence.

View File

@@ -28,7 +28,7 @@ public interface BlockDeviceQuery {
BlockPos getQueryPosition();
/**
* The side of the block this query is performed on, if any.
* The world-space side of the block this query is performed on, if any.
* <p>
* May be {@code null} just as when requesting a capability from a {@link BlockEntity}.
*

View File

@@ -1,6 +1,10 @@
package li.cil.oc2.api.capabilities;
import li.cil.oc2.api.bus.device.provider.BlockDeviceQuery;
import li.cil.oc2.api.bus.device.provider.ItemDeviceQuery;
import net.minecraft.world.entity.Entity;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.level.block.entity.BlockEntity;
/**
* This interface provides access to a list of {@link Player}s that are currently
@@ -8,6 +12,10 @@ import net.minecraft.world.entity.player.Player;
* <p>
* For example, for computers and robots this is the list of players that currently have
* the terminal UI opened.
* <p>
* Must be implemented by the {@link BlockEntity} or {@link Entity} that serves as the
* context for device creation via {@link BlockDeviceQuery}s or {@link ItemDeviceQuery}s,
* respectively.
*/
public interface TerminalUserProvider {
/**