Added missing documentation.

2020-12-29 18:46:51 +01:00
parent f2485af8d0
commit eefcaa5773
1 changed files with 3 additions and 1 deletions
--- a/src/main/java/li/cil/oc2/api/bus/device/vm/InterruptAllocator.java
+++ b/src/main/java/li/cil/oc2/api/bus/device/vm/InterruptAllocator.java
@@ -1,5 +1,6 @@
 package li.cil.oc2.api.bus.device.vm;

+import java.util.Optional;
 import java.util.OptionalInt;

 /**
@@ -22,7 +23,8 @@ public interface InterruptAllocator {
    OptionalInt claimInterrupt(int interrupt);

    /**
-     *
+     * Tries to claim the next free interrupt. If no more interrupts are available,
+     * this will return {@link Optional#empty()}.
     *
     * @return the interrupt that was claimed, if any.
     */