From 6aee30c29c0f6cc12b796f90f813b853dc5be56d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20N=C3=BCcke?= <florian@nuecke.de>
Date: Sun, 9 May 2021 12:17:59 +0200
Subject: [PATCH] robot doc

---
 .../java/li/cil/oc2/api/capabilities/Robot.java | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/main/java/li/cil/oc2/api/capabilities/Robot.java b/src/main/java/li/cil/oc2/api/capabilities/Robot.java
index 5ce0cf0c..630ff437 100644
--- a/src/main/java/li/cil/oc2/api/capabilities/Robot.java
+++ b/src/main/java/li/cil/oc2/api/capabilities/Robot.java
@@ -7,9 +7,26 @@ import net.minecraftforge.items.ItemStackHandler;
  * modules installed in them to interact with them.
  */
 public interface Robot {
+    /**
+     * Provides access to the inventory of the robot.
+     * <p>
+     * This does <em>not</em> include the hardware configuration part of the inventory.
+     *
+     * @return the inventory of the robot.
+     */
     ItemStackHandler getInventory();
 
+    /**
+     * The index of the currently selected slot in the inventory.
+     *
+     * @return the selected slot.
+     */
     int getSelectedSlot();
 
+    /**
+     * Sets the index of the currently selected slot in the inventory.
+     *
+     * @param value the slot to select.
+     */
     void setSelectedSlot(final int value);
 }