Misc Javadoc fixes and minor header update

Author: Luke Spragg

pom.xml

@@ -83,11 +83,11 @@
     <repositories>
         <repository>
             <id>sonatype-nexus-releases</id>
-            <url>https://oss.sonatype.org/content/repositories/releases/</url>
+            <url>https://oss.sonatype.org/content/repositories/releases</url>
         </repository>
         <repository>
             <id>sonatype-nexus-snapshots</id>
-            <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
+            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
             <snapshots>
                 <enabled>true</enabled>
                 <updatePolicy>always</updatePolicy>
@@ -99,11 +99,11 @@
     <pluginRepositories>
         <pluginRepository>
             <id>sonatype-nexus-releases</id>
-            <url>https://oss.sonatype.org/content/repositories/releases/</url>
+            <url>https://oss.sonatype.org/content/repositories/releases</url>
         </pluginRepository>
         <pluginRepository>
             <id>sonatype-nexus-snapshots</id>
-            <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
+            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
             <snapshots>
                 <enabled>true</enabled>
                 <updatePolicy>always</updatePolicy>
@@ -114,35 +114,35 @@
     <!-- Project dependencies -->
     <dependencies>
         <!-- Transitive -->
-        <dependency>
-            <groupId>org.apache.commons</groupId>
-            <artifactId>commons-lang3</artifactId>
-            <version>3.3.2</version>
-            <scope>compile</scope>
-        </dependency>
         <dependency>
             <groupId>com.flowpowered</groupId>
             <artifactId>flow-math</artifactId>
             <version>0.1.0-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>com.github.wolf480pl</groupId>
+            <artifactId>jline-log4j2-appender</artifactId>
+            <version>1.0.0-SNAPSHOT</version>
+            <scope>compile</scope>
+            <optional>true</optional>
+        </dependency>
         <dependency>
             <groupId>jline</groupId>
             <artifactId>jline</artifactId>
             <version>2.12</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
-            <groupId>com.github.wolf480pl</groupId>
-            <artifactId>jline-log4j2-appender</artifactId>
-            <version>0.0.1-SNAPSHOT</version>
+            <groupId>net.sf.trove4j</groupId>
+            <artifactId>trove4j</artifactId>
+            <version>3.0.3</version>
             <scope>compile</scope>
-            <optional>true</optional>
         </dependency>
         <dependency>
-            <groupId>uk.org.lidalia</groupId>
-            <artifactId>lidalia-slf4j-ext</artifactId>
-            <version>1.0.0</version>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.3.2</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
@@ -152,9 +152,9 @@
             <scope>compile</scope>
         </dependency>
         <dependency>
-            <groupId>net.sf.trove4j</groupId>
-            <artifactId>trove4j</artifactId>
-            <version>3.0.3</version>
+            <groupId>uk.org.lidalia</groupId>
+            <artifactId>lidalia-slf4j-ext</artifactId>
+            <version>1.0.0</version>
             <scope>compile</scope>
         </dependency>
         <!-- Testing only -->

src/main/java/com/flowpowered/commons/ViewFrustum.java

@@ -88,21 +88,21 @@ public void update(Matrix4f projection, Matrix4f view) {
 
     /**
      * Returns a new array containing the vertices of the frustum. They are in the following order, given by the intersection of the planes:
-     * <p/>
+     * <br>
      * RIGHT - TOP - NEAR
-     * <p/>
+     * <br>
      * RIGHT - TOP - FAR
-     * <p/>
+     * <br>
      * RIGHT - BOTTOM - NEAR
-     * <p/>
+     * <br>
      * RIGHT - BOTTOM - FAR
-     * <p/>
+     * <br>
      * LEFT - TOP - NEAR
-     * <p/>
+     * <br>
      * LEFT - TOP - FAR
-     * <p/>
+     * <br>
      * LEFT - BOTTOM - NEAR
-     * <p/>
+     * <br>
      * LEFT - BOTTOM - FAR
      *
      * @return An array containing the frustum vertices

src/main/java/com/flowpowered/commons/map/impl/TSyncIntObjectHashMap.java

@@ -1,31 +1,25 @@
 /*
- * This file is part of Flow Commons.
+ * This file is part of Flow Commons, licensed under the MIT License (MIT).
  *
- * Copyright (c) 2013 Spout LLC <http://www.spout.org/>
+ * Copyright (c) 2013 Spout LLC <https://spout.org/>
  *
- * Effective until June 25, 2014, this file is license under the Spout License Version 1.
- * After June 25, 2014, this file becomes licensed under the MIT license.
- * All changes occuring after Janurary 31, 2014 are immediately consider licensed under the MIT license.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * Spout is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option)
- * any later version.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * In addition, 180 days after any changes are published, you can use the
- * software, incorporating those changes, under the terms of the MIT license,
- * as described in the Spout License Version 1.
- *
- * Spout is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
- * more details.
- *
- * You should have received a copy of the GNU Lesser General Public License,
- * the MIT license and the Spout License Version 1 along with this program.
- * If not, see <http://www.gnu.org/licenses/> for the GNU Lesser General Public
- * License and see <http://spout.in/licensev1> for the full license, including
- * the MIT license.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
  */
 package com.flowpowered.commons.map.impl;
 

src/main/java/com/flowpowered/commons/map/impl/TTripleInt21ObjectHashMap.java

@@ -91,9 +91,9 @@ public T putIfAbsent(int x, int y, int z, T value) {
     }
 
     /**
-     * Returns the value to which the specified key is mapped, or <code>null</code> if this map contains no mapping for the key. <p> More formally, if this map contains a mapping from a key
+     * Returns the value to which the specified key is mapped, or <code>null</code> if this map contains no mapping for the key.<br> More formally, if this map contains a mapping from a key
      * <code>k</code> to a value <code>v</code> such that <code>(key==null ? k==null : key.equals(k))</code>, then this method returns <code>v</code>; otherwise it returns <code>null</code>. (There
-     * can be at most one such mapping.) <p> If this map permits <code>null</code> values, then a return value of <code>null</code> does not <i>necessarily</i> indicate that the map contains no
+     * can be at most one such mapping.)<br> If this map permits <code>null</code> values, then a return value of <code>null</code> does not <i>necessarily</i> indicate that the map contains no
      * mapping for the key; it's also possible that the map explicitly maps the key to <code>null</code>. The {@see #containsKey(int, int, int) containsKey} operation may be used to distinguish these
      * two cases.
      *
@@ -188,9 +188,9 @@ public long[] keys() {
 
     /**
      * Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key <code>k</code> to value <code>v</code> such that
-     * <code>key.equals(k)</code>, that mapping is removed. (The map can contain at most one such mapping.) <p> Returns the value to which this map previously associated the key, or <code>null</code>
-     * if the map contained no mapping for the key. </p> If this map permits null values, then a return value of <code>null</code> does not <i>necessarily</i> indicate that the map contained no
-     * mapping for the key; it's also possible that the map explicitly mapped the key to <code>null</code>. <p> The map will not contain a mapping for the specified key once the call returns.
+     * <code>key.equals(k)</code>, that mapping is removed. (The map can contain at most one such mapping.)<br> Returns the value to which this map previously associated the key, or <code>null</code>
+     * if the map contained no mapping for the key.<br> If this map permits null values, then a return value of <code>null</code> does not <i>necessarily</i> indicate that the map contained no
+     * mapping for the key; it's also possible that the map explicitly mapped the key to <code>null</code>.<br> The map will not contain a mapping for the specified key once the call returns.
      *
      * @param x an <code>int</code> value
      * @param y an <code>int</code> value

src/main/java/com/flowpowered/commons/queue/SubscribableQueue.java

@@ -37,15 +37,15 @@
  * {@link #addAll(java.util.Collection)} or {@link #offer(Object)}) will be added to all the thread queues, but any removal operation is confined to the thread's queue. A thread needs to subscribe to
  * the queue before being able to use it, using {@link #subscribe()}. The queue to use is selected from the calling thread, using {@link Thread#currentThread()}. Once done, a thread should unsubscribe
  * using {@link #unsubscribe()}.
- * <p/>
+ * <br>
  * When a thread constructs a new {@link SubscribableQueue}, it can declared itself as the publisher thread, and the operation of the following methods is limited to that thread only: {@link
  * #unsubscribeAll()}. The following operations operate on all queues if called by the publisher, else on the thread's own queue: {@link #add(Object)}, {@link #addAll(java.util.Collection)}, {@link
  * #offer(Object)}.
- * <p/>
+ * <br>
  * It's possible to add objects for only specific subscribers, as long as they have provided a non-null identifier object when using {@link #subscribe(Object)}, and that the publisher knows which
  * object corresponds to which thread. Calling {@link #add(Object, Object)}, {@link #addAll(java.util.Collection, Object)} or {@link #offer(Object, Object)} using a valid identifier will ensure that
  * the object is only passed to the desired subscriber.
- * <p/>
+ * <br>
  * Calls to methods can be expensive because of the cost of {@link Thread#currentThread()} on certain platforms. Using mass removal or addition operations ({@link #removeAll(java.util.Collection)},
  * {@link #addAll(java.util.Collection)}) is recommended when multiple items need to be removed or added.
  */

src/main/java/com/flowpowered/commons/store/block/impl/AtomicVariableWidthArray.java

@@ -254,7 +254,7 @@ public final int width() {
     }
 
     /**
-     * Gets an array containing all the values in the array. The returned values are not guaranteed to be from the same time instant. <p/> If an array is provided and it is the correct length, then
+     * Gets an array containing all the values in the array. The returned values are not guaranteed to be from the same time instant.<br> If an array is provided and it is the correct length, then
      * that array will be used as the destination array.
      *
      * @param array the provided array
@@ -284,10 +284,9 @@ public int[] getPacked() {
         return packed;
     }
 
-    /*
+    /**
      * Remaining methods use the above methods
      */
-
     public int addAndGet(int i, int delta) {
         return addAndGet(i, delta, false);
     }

src/main/java/com/flowpowered/commons/ticking/Timer.java

@@ -30,7 +30,7 @@
 /**
  * A time class. Calling the {@link #sync()} method at the end of each tick will cause the thread to sleep for the correct time delay between the ticks. {@link #start()} must be called just before the
  * loop to start the timer. {@link #reset()} is used to reset the start time to the current time.
- * <p/>
+ * <br>
  * Based on LWJGL's implementation of {@link org.lwjgl.opengl.Sync}.
  */
 public class Timer {