Remove unnecessary @NotNull and add JavaDocs

iso2013 · Aug 21, 2018 · 268f821 · 268f821
1 parent bc52e5a
commit 268f821
Show file tree

Hide file tree

Showing 30 changed files with 6,358 additions and 2 deletions.
diff --git a/API/src/main/java/net/blitzcube/mlapi/api/tag/ITagController.java b/API/src/main/java/net/blitzcube/mlapi/api/tag/ITagController.java
@@ -1,6 +1,5 @@
 package net.blitzcube.mlapi.api.tag;
 
-import com.sun.istack.internal.NotNull;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.EntityType;
 import org.bukkit.entity.Player;
@@ -57,7 +56,6 @@ default String getName(Entity target, Player viewer, String previous) {
      *
      * @return the controlling plugin
      */
-    @NotNull
     JavaPlugin getPlugin();
 
     /**

diff --git a/docs/javadocs/allclasses-frame.html b/docs/javadocs/allclasses-frame.html
@@ -0,0 +1,28 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+    <!-- Generated by javadoc (1.8.0_161) on Tue Aug 21 16:01:20 MDT 2018 -->
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <title>All Classes (PacketEntityAPI docs v2.0.0a-SNAPSHOT)</title>
+    <meta name="date" content="2018-08-21">
+    <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+    <script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<h1 class="bar">All&nbsp;Classes</h1>
+<div class="indexContainer">
+    <ul>
+        <li><a href="net/blitzcube/mlapi/api/IMultiLineAPI.html" title="interface in net.blitzcube.mlapi.api"
+               target="classFrame"><span class="interfaceName">IMultiLineAPI</span></a></li>
+        <li><a href="net/blitzcube/mlapi/api/tag/ITag.html" title="interface in net.blitzcube.mlapi.api.tag"
+               target="classFrame"><span class="interfaceName">ITag</span></a></li>
+        <li><a href="net/blitzcube/mlapi/api/tag/ITagController.html" title="interface in net.blitzcube.mlapi.api.tag"
+               target="classFrame"><span class="interfaceName">ITagController</span></a></li>
+        <li><a href="net/blitzcube/mlapi/api/tag/ITagController.TagLine.html"
+               title="interface in net.blitzcube.mlapi.api.tag" target="classFrame"><span class="interfaceName">ITagController.TagLine</span></a>
+        </li>
+    </ul>
+</div>
+</body>
+</html>
diff --git a/docs/javadocs/allclasses-noframe.html b/docs/javadocs/allclasses-noframe.html
@@ -0,0 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+    <!-- Generated by javadoc (1.8.0_161) on Tue Aug 21 16:01:20 MDT 2018 -->
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <title>All Classes (PacketEntityAPI docs v2.0.0a-SNAPSHOT)</title>
+    <meta name="date" content="2018-08-21">
+    <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+    <script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<h1 class="bar">All&nbsp;Classes</h1>
+<div class="indexContainer">
+    <ul>
+        <li><a href="net/blitzcube/mlapi/api/IMultiLineAPI.html" title="interface in net.blitzcube.mlapi.api"><span
+                class="interfaceName">IMultiLineAPI</span></a></li>
+        <li><a href="net/blitzcube/mlapi/api/tag/ITag.html" title="interface in net.blitzcube.mlapi.api.tag"><span
+                class="interfaceName">ITag</span></a></li>
+        <li><a href="net/blitzcube/mlapi/api/tag/ITagController.html"
+               title="interface in net.blitzcube.mlapi.api.tag"><span class="interfaceName">ITagController</span></a>
+        </li>
+        <li><a href="net/blitzcube/mlapi/api/tag/ITagController.TagLine.html"
+               title="interface in net.blitzcube.mlapi.api.tag"><span
+                class="interfaceName">ITagController.TagLine</span></a></li>
+    </ul>
+</div>
+</body>
+</html>
diff --git a/docs/javadocs/constant-values.html b/docs/javadocs/constant-values.html
@@ -0,0 +1,134 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+    <!-- Generated by javadoc (1.8.0_161) on Tue Aug 21 16:01:20 MDT 2018 -->
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <title>Constant Field Values (PacketEntityAPI docs v2.0.0a-SNAPSHOT)</title>
+    <meta name="date" content="2018-08-21">
+    <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+    <script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+    try {
+        if (location.href.indexOf('is-external=true') == -1) {
+            parent.document.title="Constant Field Values (PacketEntityAPI docs v2.0.0a-SNAPSHOT)";
+        }
+    }
+    catch(err) {
+    }
+//-->
+
+
+</script>
+<noscript>
+    <div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+    <!--   -->
+</a>
+    <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+    <a name="navbar.top.firstrow">
+        <!--   -->
+    </a>
+    <ul class="navList" title="Navigation">
+        <li><a href="overview-summary.html">Overview</a></li>
+        <li>Package</li>
+        <li>Class</li>
+        <li>Use</li>
+        <li><a href="overview-tree.html">Tree</a></li>
+        <li><a href="deprecated-list.html">Deprecated</a></li>
+        <li><a href="index-all.html">Index</a></li>
+        <li><a href="help-doc.html">Help</a></li>
+    </ul>
+</div>
+<div class="subNav">
+    <ul class="navList">
+        <li>Prev</li>
+        <li>Next</li>
+    </ul>
+    <ul class="navList">
+        <li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
+        <li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
+    </ul>
+    <ul class="navList" id="allclasses_navbar_top">
+        <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
+    </ul>
+    <div>
+        <script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_top");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+
+
+        </script>
+    </div>
+    <a name="skip.navbar.top">
+        <!--   -->
+    </a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+    <h1 title="Constant Field Values" class="title">Constant Field Values</h1>
+    <h2 title="Contents">Contents</h2>
+</div>
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+    <!--   -->
+</a>
+    <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+    <a name="navbar.bottom.firstrow">
+        <!--   -->
+    </a>
+    <ul class="navList" title="Navigation">
+        <li><a href="overview-summary.html">Overview</a></li>
+        <li>Package</li>
+        <li>Class</li>
+        <li>Use</li>
+        <li><a href="overview-tree.html">Tree</a></li>
+        <li><a href="deprecated-list.html">Deprecated</a></li>
+        <li><a href="index-all.html">Index</a></li>
+        <li><a href="help-doc.html">Help</a></li>
+    </ul>
+</div>
+<div class="subNav">
+    <ul class="navList">
+        <li>Prev</li>
+        <li>Next</li>
+    </ul>
+    <ul class="navList">
+        <li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
+        <li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
+    </ul>
+    <ul class="navList" id="allclasses_navbar_bottom">
+        <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
+    </ul>
+    <div>
+        <script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_bottom");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+
+
+        </script>
+    </div>
+    <a name="skip.navbar.bottom">
+        <!--   -->
+    </a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy">
+    <small>Copyright &#169; 2018. All rights reserved.</small>
+</p>
+</body>
+</html>
diff --git a/docs/javadocs/deprecated-list.html b/docs/javadocs/deprecated-list.html
@@ -0,0 +1,134 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+    <!-- Generated by javadoc (1.8.0_161) on Tue Aug 21 16:01:20 MDT 2018 -->
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <title>Deprecated List (PacketEntityAPI docs v2.0.0a-SNAPSHOT)</title>
+    <meta name="date" content="2018-08-21">
+    <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+    <script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+    try {
+        if (location.href.indexOf('is-external=true') == -1) {
+            parent.document.title="Deprecated List (PacketEntityAPI docs v2.0.0a-SNAPSHOT)";
+        }
+    }
+    catch(err) {
+    }
+//-->
+
+
+</script>
+<noscript>
+    <div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+    <!--   -->
+</a>
+    <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+    <a name="navbar.top.firstrow">
+        <!--   -->
+    </a>
+    <ul class="navList" title="Navigation">
+        <li><a href="overview-summary.html">Overview</a></li>
+        <li>Package</li>
+        <li>Class</li>
+        <li>Use</li>
+        <li><a href="overview-tree.html">Tree</a></li>
+        <li class="navBarCell1Rev">Deprecated</li>
+        <li><a href="index-all.html">Index</a></li>
+        <li><a href="help-doc.html">Help</a></li>
+    </ul>
+</div>
+<div class="subNav">
+    <ul class="navList">
+        <li>Prev</li>
+        <li>Next</li>
+    </ul>
+    <ul class="navList">
+        <li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
+        <li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
+    </ul>
+    <ul class="navList" id="allclasses_navbar_top">
+        <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
+    </ul>
+    <div>
+        <script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_top");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+
+
+        </script>
+    </div>
+    <a name="skip.navbar.top">
+        <!--   -->
+    </a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+    <h1 title="Deprecated API" class="title">Deprecated API</h1>
+    <h2 title="Contents">Contents</h2>
+</div>
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+    <!--   -->
+</a>
+    <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+    <a name="navbar.bottom.firstrow">
+        <!--   -->
+    </a>
+    <ul class="navList" title="Navigation">
+        <li><a href="overview-summary.html">Overview</a></li>
+        <li>Package</li>
+        <li>Class</li>
+        <li>Use</li>
+        <li><a href="overview-tree.html">Tree</a></li>
+        <li class="navBarCell1Rev">Deprecated</li>
+        <li><a href="index-all.html">Index</a></li>
+        <li><a href="help-doc.html">Help</a></li>
+    </ul>
+</div>
+<div class="subNav">
+    <ul class="navList">
+        <li>Prev</li>
+        <li>Next</li>
+    </ul>
+    <ul class="navList">
+        <li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
+        <li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
+    </ul>
+    <ul class="navList" id="allclasses_navbar_bottom">
+        <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
+    </ul>
+    <div>
+        <script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_bottom");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+
+
+        </script>
+    </div>
+    <a name="skip.navbar.bottom">
+        <!--   -->
+    </a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy">
+    <small>Copyright &#169; 2018. All rights reserved.</small>
+</p>
+</body>
+</html>