fix javadoc issues

codehaus-plexus · Jul 29, 2021 · 7d26d04 · 7d26d04
1 parent 17ed658
commit 7d26d04
Show file tree

Hide file tree

Showing 53 changed files with 1,958 additions and 172 deletions.
diff --git a/src/test/java/org/codehaus/plexus/util/AbstractTestThread.java b/src/test/java/org/codehaus/plexus/util/AbstractTestThread.java
@@ -24,14 +24,16 @@
  * </p>
  *
  * @author <a href="mailto:bert@tuaworks.co.nz">Bert van Brakel</a>
- *
+ * @version $Id: $Id
+ * @since 3.4.0
  */
 public abstract class AbstractTestThread
     implements Runnable
 {
     // ~ Instance fields ----------------------------------------------------------------------------
     private String name;
 
+    /** Constant <code>DEBUG=true</code> */
     public static final boolean DEBUG = true;
 
     private boolean isRunning = false;
@@ -68,6 +70,11 @@ public AbstractTestThread()
         super();
     }
 
+    /**
+     * <p>Constructor for AbstractTestThread.</p>
+     *
+     * @param registry a {@link org.codehaus.plexus.util.TestThreadManager} object.
+     */
     public AbstractTestThread( TestThreadManager registry )
     {
         super();
@@ -77,7 +84,9 @@ public AbstractTestThread( TestThreadManager registry )
     // ~ Methods ------------------------------------------------------------------------------------
 
     /**
-     * @return
+     * <p>Getter for the field <code>error</code>.</p>
+     *
+     * @return a {@link java.lang.Throwable} object.
      */
     public Throwable getError()
     {
@@ -129,15 +138,19 @@ public final void start()
     }
 
     /**
-     * @return
+     * <p>Getter for the field <code>errorMsg</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
      */
     public String getErrorMsg()
     {
         return errorMsg;
     }
 
     /**
-     * @return
+     * <p>hasFailed.</p>
+     *
+     * @return a boolean.
      */
     public boolean hasFailed()
     {
@@ -189,15 +202,15 @@ public final void run()
     /**
      * Override this to run your custom test
      *
-     * @throws Throwable
+     * @throws java.lang.Throwable
      */
     public abstract void doRun()
         throws Throwable;
 
     /**
      * Set the registry this thread should notify when it has completed running
      *
-     * @param registry
+     * @param registry a {@link org.codehaus.plexus.util.TestThreadManager} object.
      */
     public void setThreadRegistry( TestThreadManager registry )
 
@@ -208,47 +221,57 @@ public void setThreadRegistry( TestThreadManager registry )
     /**
      * Test if the test has run
      *
-     * @return
+     * @return a boolean.
      */
     public boolean hasRun()
     {
         return hasRun;
     }
 
     /**
-     * @param throwable
+     * <p>Setter for the field <code>error</code>.</p>
+     *
+     * @param throwable a {@link java.lang.Throwable} object.
      */
     public void setError( Throwable throwable )
     {
         error = throwable;
     }
 
     /**
-     * @param string
+     * <p>Setter for the field <code>errorMsg</code>.</p>
+     *
+     * @param string a {@link java.lang.String} object.
      */
     public void setErrorMsg( String string )
     {
         errorMsg = string;
     }
 
     /**
-     * @param b
+     * <p>Setter for the field <code>passed</code>.</p>
+     *
+     * @param b a boolean.
      */
     public void setPassed( boolean b )
     {
         passed = b;
     }
 
     /**
-     * @return
+     * <p>Getter for the field <code>name</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
      */
     public String getName()
     {
         return name;
     }
 
     /**
-     * @param string
+     * <p>Setter for the field <code>name</code>.</p>
+     *
+     * @param string a {@link java.lang.String} object.
      */
     public void setName( String string )
     {

diff --git a/src/test/java/org/codehaus/plexus/util/CollectionUtilsTest.java b/src/test/java/org/codehaus/plexus/util/CollectionUtilsTest.java
@@ -28,8 +28,18 @@
 
 import org.junit.Test;
 
+/**
+ * <p>CollectionUtilsTest class.</p>
+ *
+ * @author herve
+ * @version $Id: $Id
+ * @since 3.4.0
+ */
 public class CollectionUtilsTest
 {
+    /**
+     * <p>testMergeMaps.</p>
+     */
     @Test
     public void testMergeMaps()
     {
@@ -66,6 +76,9 @@ public void testMergeMaps()
         assertEquals( "z", result.get( "z" ) );
     }
 
+    /**
+     * <p>testMergeMapArray.</p>
+     */
     @SuppressWarnings( "unchecked" )
     @Test
     public void testMergeMapArray()
@@ -119,6 +132,9 @@ public void testMergeMapArray()
         assertEquals( "ccc", result5.get( "c" ) );
     }
 
+    /**
+     * <p>testMavenPropertiesLoading.</p>
+     */
     @Test
     public void testMavenPropertiesLoading()
     {
@@ -176,6 +192,9 @@ public void testMavenPropertiesLoading()
         assertEquals( mavenRepoRemote, (String) result.get( "maven.repo.remote" ) );
     }
 
+    /**
+     * <p>testIteratorToListWithAPopulatedList.</p>
+     */
     @Test
     public void testIteratorToListWithAPopulatedList()
     {
@@ -196,6 +215,9 @@ public void testIteratorToListWithAPopulatedList()
         assertEquals( "tre", copy.get( 2 ) );
     }
 
+    /**
+     * <p>testIteratorToListWithAEmptyList.</p>
+     */
     @Test
     public void testIteratorToListWithAEmptyList()
     {