From eefcaa57738f635dec4c57ea9a0bef584d0df3f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20N=C3=BCcke?= <florian@nuecke.de>
Date: Tue, 29 Dec 2020 18:46:51 +0100
Subject: [PATCH] Added missing documentation.

---
 .../java/li/cil/oc2/api/bus/device/vm/InterruptAllocator.java | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git 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
index 915d7cd7..7675fc00 100644
--- 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.
      */