Add documentation for Hooks

Signed-off-by: Tomas Slusny <[email protected]>
IanMcNelly · Jun 22, 2018 · d21cac1 · d21cac1
1 parent ffbc89a
commit d21cac1
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java b/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java
@@ -60,6 +60,11 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * This class contains field required for mixins and runelite hooks to work.
+ * All remaining method hooks in this class are performance-critical or contain client-specific logic and so they
+ * can't just be placed in mixins or sent through event bus.
+ */
 public class Hooks
 {
 	// must be public as the mixins use it