From 87360899f3c6c988729bc422e77255afbcee5e73 Mon Sep 17 00:00:00 2001
From: Hammy <sgoudham@gmail.com>
Date: Sun, 6 Jun 2021 18:00:01 +0100
Subject: [PATCH] Update documentation

---
 src/main/java/org/goudham/me/Response.java | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/main/java/org/goudham/me/Response.java b/src/main/java/org/goudham/me/Response.java
index c9e2e8e..56fa3fc 100644
--- a/src/main/java/org/goudham/me/Response.java
+++ b/src/main/java/org/goudham/me/Response.java
@@ -1,5 +1,22 @@
 package org.goudham.me;
 
+import org.goudham.me.api.entity.series.Series;
+import org.goudham.me.api.entity.waifu.Waifu;
+
+/**
+ * This is returned to the User when called by methods in {@link MyWaifuClient}
+ * <br>
+ * E.g {@link MyWaifuClient#getWaifu(Integer)}
+ * <br>
+ * Given a successful response, {@link #entity} will be populated with the requested entity.
+ * <br>
+ * No matter successful or unsuccessful response, {@link #responseCode} and {@link #responseBody}
+ * will be populated to ensure the user has all the information for debugging or extra information within
+ * the {@link #responseBody}
+ *
+ * @param <T> The type of entity to be returned. E.g {@link Waifu} or {@link Series}
+ *
+ */
 public class Response<T> {
     private T entity;
     private final Integer responseCode;