From f6a9518717313281b29b5ec1bafcb2264b66012b Mon Sep 17 00:00:00 2001
From: Chris Cromer <chris@cromer.cl>
Date: Sun, 6 Oct 2019 17:23:47 -0300
Subject: [PATCH] Add missing javadoc elements

Signed-off-by: Chris Cromer <chris@cromer.cl>
---
 .idea/inspectionProfiles/Project_Default.xml  | 43 +++++++++++++++++++
 .../java/cl/cromer/azaraka/object/Gem.java    |  8 ++++
 2 files changed, 51 insertions(+)

diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
index a3e7ede..9969356 100644
--- a/.idea/inspectionProfiles/Project_Default.xml
+++ b/.idea/inspectionProfiles/Project_Default.xml
@@ -1,6 +1,49 @@
 <component name="InspectionProjectProfileManager">
   <profile version="1.0">
     <option name="myName" value="Project Default" />
+    <inspection_tool class="JavaDoc" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="TOP_LEVEL_CLASS_OPTIONS">
+        <value>
+          <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="package" />
+          <option name="REQUIRED_TAGS" value="@param" />
+        </value>
+      </option>
+      <option name="INNER_CLASS_OPTIONS">
+        <value>
+          <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="private" />
+          <option name="REQUIRED_TAGS" value="" />
+        </value>
+      </option>
+      <option name="METHOD_OPTIONS">
+        <value>
+          <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="private" />
+          <option name="REQUIRED_TAGS" value="@return@param@throws or @exception" />
+        </value>
+      </option>
+      <option name="FIELD_OPTIONS">
+        <value>
+          <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="private" />
+          <option name="REQUIRED_TAGS" value="" />
+        </value>
+      </option>
+      <option name="IGNORE_DEPRECATED" value="false" />
+      <option name="IGNORE_JAVADOC_PERIOD" value="true" />
+      <option name="IGNORE_DUPLICATED_THROWS" value="false" />
+      <option name="IGNORE_POINT_TO_ITSELF" value="false" />
+      <option name="myAdditionalJavadocTags" value="" />
+      <option name="MODULE_OPTIONS">
+        <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="public" />
+        <option name="REQUIRED_TAGS" value="" />
+      </option>
+      <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="public" />
+      <option name="REQUIRED_TAGS" value="" />
+    </inspection_tool>
+    <inspection_tool class="MissingPackageInfo" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="PackageDotHtmlMayBePackageInfo" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="PackageInfoWithoutPackage" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="UnnecessaryJavaDocLink" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="ignoreInlineLinkToSuper" value="false" />
+    </inspection_tool>
     <inspection_tool class="WeakerAccess" enabled="true" level="WARNING" enabled_by_default="true">
       <option name="SUGGEST_PACKAGE_LOCAL_FOR_MEMBERS" value="false" />
       <option name="SUGGEST_PACKAGE_LOCAL_FOR_TOP_CLASSES" value="false" />
diff --git a/src/main/java/cl/cromer/azaraka/object/Gem.java b/src/main/java/cl/cromer/azaraka/object/Gem.java
index a02ae6e..5704367 100644
--- a/src/main/java/cl/cromer/azaraka/object/Gem.java
+++ b/src/main/java/cl/cromer/azaraka/object/Gem.java
@@ -52,6 +52,8 @@ public class Gem extends Object {
 
 	/**
 	 * Load the gem animations
+	 *
+	 * @param type The type of gem to load the animation for
 	 */
 	private void loadGemAnimation(Type type) {
 		if (type == null) {
@@ -165,7 +167,13 @@ public class Gem extends Object {
 	 * The type of gem
 	 */
 	public enum Type {
+		/**
+		 * The life gem which should be blue
+		 */
 		LIFE,
+		/**
+		 * The death gem which should be red
+		 */
 		DEATH
 	}