Jika/oc2r
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Removed copy-pasted package javadoc.

Browse Source
This commit is contained in:
Florian Nücke
2022-01-15 19:33:44 +01:00
parent 56e00a14bf
commit 6e5d71b9b4
2 changed files with 0 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
src/main/java/li/cil/oc2/api/bus/device/data/package-info.java
View File

@@ -1,43 +1,3 @@
/**
* The device bus is the glue that connects devices and VMs.
* <p>
* A bus must always be managed by a {@link li.cil.oc2.api.bus.DeviceBusController}.
* If there is no controller, there is no (connected) bus.
* <p>
* When a controller performs a scan, it collects a list of connected
* {@link li.cil.oc2.api.bus.DeviceBusElement}s thus defining a
* {@link li.cil.oc2.api.bus.DeviceBus}.
* How the controller scans for elements depends on the implementation.
* One example is a block-based controller which scans adjacent blocks
* in a recursive manner -- usually up to some maximum bus complexity.
* <p>
* {@link li.cil.oc2.api.bus.DeviceBusElement}s are responsible for
* providing a list of devices connected to them. Whether they play an
* active role and seek out devices, or passively expect devices to be
* registered with them depends on the implementation implementation.
* <p>
* After a scan {@link li.cil.oc2.api.bus.DeviceBusController}s then
* collect all devices from all bus elements to build a global set
* of devices on the bus.
* <p>
* There can be various types of devices on a bus, but which types are
* supported will depend on the context of the controller. Currently two
* types of devices are are defined in this API, {@link li.cil.oc2.api.bus.device.rpc.RPCDevice}
* and {@link li.cil.oc2.api.bus.device.vm.VMDevice}.
* <ul>
* <li>
* RPC devices are a high-level system for providing VMs with means of
* calling methods on such devices. The protocol used allows VMs to
* dynamically detect what devices are present and what methods may be
* called on them.
* </li>
* <li>
* VM devices are low-level devices that may register emulations of actual
* devices with a VM. Such devices will require drivers to be present
* inside the VM to work.
* </li>
* </ul>
*/
@ParametersAreNonnullByDefault
@MethodsReturnNonnullByDefault
package li.cil.oc2.api.bus.device.data;

40
src/main/java/li/cil/oc2/api/bus/device/package-info.java
View File

@@ -1,43 +1,3 @@
/**
* The device bus is the glue that connects devices and VMs.
* <p>
* A bus must always be managed by a {@link li.cil.oc2.api.bus.DeviceBusController}.
* If there is no controller, there is no (connected) bus.
* <p>
* When a controller performs a scan, it collects a list of connected
* {@link li.cil.oc2.api.bus.DeviceBusElement}s thus defining a
* {@link li.cil.oc2.api.bus.DeviceBus}.
* How the controller scans for elements depends on the implementation.
* One example is a block-based controller which scans adjacent blocks
* in a recursive manner -- usually up to some maximum bus complexity.
* <p>
* {@link li.cil.oc2.api.bus.DeviceBusElement}s are responsible for
* providing a list of devices connected to them. Whether they play an
* active role and seek out devices, or passively expect devices to be
* registered with them depends on the implementation implementation.
* <p>
* After a scan {@link li.cil.oc2.api.bus.DeviceBusController}s then
* collect all devices from all bus elements to build a global set
* of devices on the bus.
* <p>
* There can be various types of devices on a bus, but which types are
* supported will depend on the context of the controller. Currently two
* types of devices are are defined in this API, {@link li.cil.oc2.api.bus.device.rpc.RPCDevice}
* and {@link li.cil.oc2.api.bus.device.vm.VMDevice}.
* <ul>
* <li>
* RPC devices are a high-level system for providing VMs with means of
* calling methods on such devices. The protocol used allows VMs to
* dynamically detect what devices are present and what methods may be
* called on them.
* </li>
* <li>
* VM devices are low-level devices that may register emulations of actual
* devices with a VM. Such devices will require drivers to be present
* inside the VM to work.
* </li>
* </ul>
*/
@ParametersAreNonnullByDefault
@MethodsReturnNonnullByDefault
package li.cil.oc2.api.bus.device;