[testng] 66/160: Fix Javadocs.

Eugene Zhukov eugene-guest at moszumanska.debian.org
Tue Aug 18 10:22:22 UTC 2015


This is an automated email from the git hooks/post-receive script.

eugene-guest pushed a commit to annotated tag testng-6.9.5
in repository testng.

commit ad662c0a3971e0461a1aaa7580fd3c7e7a114a02
Author: Cedric Beust <cedric at beust.com>
Date:   Wed Jun 3 06:12:15 2015 -0700

    Fix Javadocs.
---
 .../java/org/testng/internal/BaseTestMethod.java   | 29 +----------------
 src/main/java/org/testng/internal/ClassHelper.java | 27 ++++++----------
 src/main/java/org/testng/internal/Constants.java   | 10 ++----
 .../java/org/testng/internal/FactoryMethod.java    | 12 +++-----
 .../org/testng/internal/ITestResultNotifier.java   |  8 ++---
 .../java/org/testng/internal/InvokedMethod.java    |  9 ++----
 src/main/java/org/testng/internal/Invoker.java     | 36 +++++++++-------------
 .../org/testng/internal/MethodGroupsHelper.java    | 19 +++++-------
 .../java/org/testng/internal/MethodHelper.java     | 21 ++++++-------
 .../org/testng/internal/MethodInheritance.java     | 14 +++------
 .../java/org/testng/internal/PackageUtils.java     | 14 +++------
 src/main/java/org/testng/internal/Parameters.java  | 11 -------
 .../java/org/testng/internal/PropertiesFile.java   |  2 +-
 .../org/testng/internal/TestNGClassFinder.java     | 16 +++++-----
 src/main/java/org/testng/internal/Utils.java       |  9 ------
 .../internal/annotations/IBaseBeforeAfter.java     |  2 +-
 .../internal/junit/ArrayComparisonFailure.java     |  2 --
 .../testng/internal/thread/IPooledExecutor.java    |  3 --
 .../java/org/testng/remote/SuiteDispatcher.java    | 18 +++--------
 src/main/java/org/testng/remote/SuiteSlave.java    | 12 +++-----
 .../remote/adapter/DefaultMastertAdapter.java      | 14 ++++-----
 .../remote/adapter/DefaultWorkerAdapter.java       | 12 ++++----
 .../org/testng/remote/adapter/IMasterAdapter.java  |  8 ++---
 .../org/testng/remote/adapter/IWorkerAdapter.java  |  8 ++---
 .../remote/adapter/RemoteResultListener.java       |  6 ++--
 .../remote/strprotocol/BaseMessageSender.java      |  7 ++---
 .../testng/remote/strprotocol/GenericMessage.java  |  3 --
 .../remote/strprotocol/IRemoteSuiteListener.java   |  2 +-
 .../org/testng/remote/strprotocol/MessageHub.java  |  7 ++---
 .../testng/remote/strprotocol/SuiteMessage.java    | 11 +++----
 .../org/testng/remote/strprotocol/TestMessage.java |  3 --
 .../remote/strprotocol/TestResultMessage.java      | 12 +++-----
 .../java/org/testng/reporters/XMLConstants.java    |  3 --
 .../java/org/testng/reporters/XMLStringBuffer.java |  9 ++----
 .../java/org/testng/util/RetryAnalyzerCount.java   |  6 ++--
 src/main/java/org/testng/xml/XMLParser.java        | 15 +++++----
 36 files changed, 133 insertions(+), 267 deletions(-)

diff --git a/src/main/java/org/testng/internal/BaseTestMethod.java b/src/main/java/org/testng/internal/BaseTestMethod.java
index 9899bcb..778a5e5 100755
--- a/src/main/java/org/testng/internal/BaseTestMethod.java
+++ b/src/main/java/org/testng/internal/BaseTestMethod.java
@@ -64,9 +64,6 @@ public abstract class BaseTestMethod implements ITestNGMethod {
 
   private List<Integer> m_invocationNumbers = Lists.newArrayList();
   private final List<Integer> m_failedInvocationNumbers = Collections.synchronizedList(Lists.<Integer>newArrayList());
-  /**
-   * {@inheritDoc}
-   */
   private long m_timeOut = 0;
 
   private boolean m_ignoreMissingDependencies;
@@ -142,12 +139,6 @@ public abstract class BaseTestMethod implements ITestNGMethod {
     m_testClass = tc;
   }
 
-  /**
-   * TODO cquezel JavaDoc.
-   *
-   * @param o
-   * @return
-   */
   @Override
   public int compareTo(Object o) {
     int result = -2;
@@ -434,7 +425,7 @@ public abstract class BaseTestMethod implements ITestNGMethod {
 
   /**
    * {@inheritDoc} This implementation returns the associated Java Method's hash code.
-   * @Return the associated Java Method's hash code.
+   * @return the associated Java Method's hash code.
    */
   @Override
   public int hashCode() {
@@ -534,11 +525,6 @@ public abstract class BaseTestMethod implements ITestNGMethod {
     return result.toString();
   }
 
-  /**
-   * TODO cquezel JavaDoc.
-   *
-   * @return
-   */
   protected String getSignature() {
     return m_signature;
   }
@@ -551,13 +537,6 @@ public abstract class BaseTestMethod implements ITestNGMethod {
     return getSignature();
   }
 
-  /**
-   * TODO cquezel JavaDoc.
-   *
-   * @param methodArray
-   * @param classArray
-   * @return
-   */
   protected String[] getStringArray(String[] methodArray, String[] classArray) {
     final Set<String> vResult = Sets.newHashSet();
     if (null != methodArray) {
@@ -640,17 +619,11 @@ public abstract class BaseTestMethod implements ITestNGMethod {
 
   /**
    * No-op.
-   * @param threadPoolSize
    */
   @Override
   public void setThreadPoolSize(int threadPoolSize) {
   }
 
-  /**
-   * TODO cquezel JavaDoc.
-   *
-   * @param description
-   */
   public void setDescription(String description) {
     m_description = description;
   }
diff --git a/src/main/java/org/testng/internal/ClassHelper.java b/src/main/java/org/testng/internal/ClassHelper.java
index 87a9ae3..ac10ec0 100644
--- a/src/main/java/org/testng/internal/ClassHelper.java
+++ b/src/main/java/org/testng/internal/ClassHelper.java
@@ -1,5 +1,15 @@
 package org.testng.internal;
 
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.Vector;
+
 import org.testng.IClass;
 import org.testng.IMethodSelector;
 import org.testng.IObjectFactory;
@@ -15,16 +25,6 @@ import org.testng.internal.annotations.IAnnotationFinder;
 import org.testng.junit.IJUnitTestRunner;
 import org.testng.xml.XmlTest;
 
-import java.lang.reflect.Constructor;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
-import java.lang.reflect.Modifier;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.Vector;
-
 /**
  * Utility class for different class manipulations.
  */
@@ -177,9 +177,6 @@ public final class ClassHelper {
   /**
    * Extract all callable methods of a class and all its super (keeping in mind
    * the Java access rules).
-   *
-   * @param clazz
-   * @return
    */
   public static Set<Method> getAvailableMethods(Class<?> clazz) {
     Set<Method> methods = Sets.newHashSet();
@@ -194,10 +191,6 @@ public final class ClassHelper {
     return methods;
   }
 
-  /**
-   * @param runner
-   * @return
-   */
   public static IJUnitTestRunner createTestRunner(TestRunner runner) {
       try {
           //try to get runner for JUnit 4 first
diff --git a/src/main/java/org/testng/internal/Constants.java b/src/main/java/org/testng/internal/Constants.java
index 836e869..aef2c1f 100755
--- a/src/main/java/org/testng/internal/Constants.java
+++ b/src/main/java/org/testng/internal/Constants.java
@@ -1,11 +1,11 @@
 package org.testng.internal;
 
-import org.testng.ITestResult;
-import org.testng.collections.Maps;
-
 import java.util.Map;
 import java.util.Properties;
 
+import org.testng.ITestResult;
+import org.testng.collections.Maps;
+
 
 
 /**
@@ -82,10 +82,6 @@ public class Constants {
     return p.getDefault();
   }
 
-  /**
-   * @param status
-   * @return
-   */
   public static String displayStatus(int status) {
     if (ITestResult.SKIP == status) {
       return "SKIP";
diff --git a/src/main/java/org/testng/internal/FactoryMethod.java b/src/main/java/org/testng/internal/FactoryMethod.java
index dc5e2e5..d599b25 100644
--- a/src/main/java/org/testng/internal/FactoryMethod.java
+++ b/src/main/java/org/testng/internal/FactoryMethod.java
@@ -1,5 +1,9 @@
 package org.testng.internal;
 
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
 import org.testng.ITestContext;
 import org.testng.ITestNGMethod;
 import org.testng.TestNGException;
@@ -8,10 +12,6 @@ import org.testng.collections.Maps;
 import org.testng.internal.annotations.IAnnotationFinder;
 import org.testng.xml.XmlTest;
 
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-
 /**
  * This class represents a method annotated with @Factory
  *
@@ -26,10 +26,6 @@ public class FactoryMethod extends BaseTestMethod {
   private XmlTest m_xmlTest = null;
   private ITestContext m_testContext = null;
 
-  /**
-   * @param testClass
-   * @param method
-   */
   public FactoryMethod(ConstructorOrMethod com,
                        Object instance,
                        XmlTest xmlTest,
diff --git a/src/main/java/org/testng/internal/ITestResultNotifier.java b/src/main/java/org/testng/internal/ITestResultNotifier.java
index c801a27..30ebd35 100755
--- a/src/main/java/org/testng/internal/ITestResultNotifier.java
+++ b/src/main/java/org/testng/internal/ITestResultNotifier.java
@@ -1,17 +1,17 @@
 package org.testng.internal;
 
+import java.util.List;
+import java.util.Set;
+
 import org.testng.IConfigurationListener;
 import org.testng.ITestListener;
 import org.testng.ITestNGMethod;
 import org.testng.ITestResult;
 import org.testng.xml.XmlTest;
 
-import java.util.List;
-import java.util.Set;
-
 /**
  * An interface defining the notification for @Test results and also
- * @Configuration results.
+ * \@Configuration results.
  *
  * @author <a href="mailto:cedric at beust.com">Cedric Beust</a>
  * @author <a href='mailto:the_mindstorm at evolva.ro'>Alexandru Popescu</a>
diff --git a/src/main/java/org/testng/internal/InvokedMethod.java b/src/main/java/org/testng/internal/InvokedMethod.java
index d97da6c..eb0a8cd 100755
--- a/src/main/java/org/testng/internal/InvokedMethod.java
+++ b/src/main/java/org/testng/internal/InvokedMethod.java
@@ -1,11 +1,11 @@
 package org.testng.internal;
 
+import java.io.Serializable;
+
 import org.testng.IInvokedMethod;
 import org.testng.ITestNGMethod;
 import org.testng.ITestResult;
 
-import java.io.Serializable;
-
 public class InvokedMethod implements Serializable, IInvokedMethod {
   private static final long serialVersionUID = 2126127194102819222L;
   transient private Object m_instance;
@@ -14,11 +14,6 @@ public class InvokedMethod implements Serializable, IInvokedMethod {
   private long m_date = System.currentTimeMillis();
   private ITestResult m_testResult;
 
-  /**
-   * @param m_object
-   * @param m_method
-   * @param m_parameters
-   */
   public InvokedMethod(Object instance,
                        ITestNGMethod method,
                        Object[] parameters,
diff --git a/src/main/java/org/testng/internal/Invoker.java b/src/main/java/org/testng/internal/Invoker.java
index 97009f8..8678a98 100644
--- a/src/main/java/org/testng/internal/Invoker.java
+++ b/src/main/java/org/testng/internal/Invoker.java
@@ -1,7 +1,16 @@
 package org.testng.internal;
 
-import static org.testng.internal.invokers.InvokedMethodListenerMethod.AFTER_INVOCATION;
-import static org.testng.internal.invokers.InvokedMethodListenerMethod.BEFORE_INVOCATION;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.regex.Pattern;
 
 import org.testng.IClass;
 import org.testng.IConfigurable;
@@ -39,17 +48,8 @@ import org.testng.xml.XmlClass;
 import org.testng.xml.XmlSuite;
 import org.testng.xml.XmlTest;
 
-import java.lang.annotation.Annotation;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.regex.Pattern;
+import static org.testng.internal.invokers.InvokedMethodListenerMethod.AFTER_INVOCATION;
+import static org.testng.internal.invokers.InvokedMethodListenerMethod.BEFORE_INVOCATION;
 
 /**
  * This class is responsible for invoking methods:
@@ -802,7 +802,7 @@ public class Invoker implements IInvoker {
   }
 
   /**
-   * {@link #invokeTestMethods()} eventually converge here to invoke a single @Test method.
+   * invokeTestMethods() eventually converge here to invoke a single @Test method.
    * <p/>
    * This method is responsible for actually invoking the method. It decides if the invocation
    * must be done:
@@ -1228,7 +1228,6 @@ public class Invoker implements IInvoker {
    * @param method method to be invoked
    * @param context test context
    * @param testResult test result
-   * @return
    */
   private Object[] injectParameters(Object[] parameterValues, Method method,
       ITestContext context, ITestResult testResult)
@@ -1350,13 +1349,6 @@ public class Invoker implements IInvoker {
     List<Object> instances = Lists.newArrayList();
   }
 
-  /**
-   * @param testMethod
-   * @param result
-   * @param expectedExceptionsHolder
-   * @param failure
-   * @return
-   */
   void handleInvocationResults(ITestNGMethod testMethod,
                                List<ITestResult> result,
                                ExpectedExceptionsHolder expectedExceptionsHolder,
diff --git a/src/main/java/org/testng/internal/MethodGroupsHelper.java b/src/main/java/org/testng/internal/MethodGroupsHelper.java
index a8d1c2c..aa7a0f4 100644
--- a/src/main/java/org/testng/internal/MethodGroupsHelper.java
+++ b/src/main/java/org/testng/internal/MethodGroupsHelper.java
@@ -1,5 +1,13 @@
 package org.testng.internal;
 
+import java.lang.reflect.Method;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.regex.Pattern;
+
 import org.testng.ITestClass;
 import org.testng.ITestNGMethod;
 import org.testng.annotations.IConfigurationAnnotation;
@@ -10,14 +18,6 @@ import org.testng.internal.annotations.AnnotationHelper;
 import org.testng.internal.annotations.IAnnotationFinder;
 import org.testng.internal.collections.Pair;
 
-import java.lang.reflect.Method;
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.concurrent.ConcurrentHashMap;
-import java.util.regex.Pattern;
-
 /**
  * Collections of helper methods to help deal with test methods
  *
@@ -150,9 +150,6 @@ public class MethodGroupsHelper {
     return result;
   }
 
-  /**
-   * @return The transitive closure of all the groups/methods included.
-   */
   protected static void findGroupTransitiveClosure(XmlMethodSelector xms,
       List<ITestNGMethod> includedMethods,
       List<ITestNGMethod> allMethods,
diff --git a/src/main/java/org/testng/internal/MethodHelper.java b/src/main/java/org/testng/internal/MethodHelper.java
index db36311..068853a 100644
--- a/src/main/java/org/testng/internal/MethodHelper.java
+++ b/src/main/java/org/testng/internal/MethodHelper.java
@@ -1,5 +1,14 @@
 package org.testng.internal;
 
+import java.lang.reflect.Method;
+import java.util.Collection;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.regex.Pattern;
+
 import org.testng.ITestNGMethod;
 import org.testng.TestNGException;
 import org.testng.annotations.IExpectedExceptionsAnnotation;
@@ -11,15 +20,6 @@ import org.testng.internal.annotations.AnnotationHelper;
 import org.testng.internal.annotations.IAnnotationFinder;
 import org.testng.internal.collections.Pair;
 
-import java.lang.reflect.Method;
-import java.util.Collection;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.concurrent.ConcurrentHashMap;
-import java.util.regex.Pattern;
-
 /**
  * Collection of helper methods to help sort and arrange methods.
  *
@@ -124,7 +124,6 @@ public class MethodHelper {
    * class name, uses the TestNG method's class name.
    * @param testngMethod TestNG method
    * @param regExp regex representing a method and/or related class name
-   * @return
    */
   private static Method findMethodByName(ITestNGMethod testngMethod, String regExp) {
     if (regExp == null) {
@@ -323,8 +322,6 @@ public class MethodHelper {
   }
 
   /**
-   * @param method
-   * @param allTestMethods
    * @return A sorted array containing all the methods 'method' depends on
    */
   public static List<ITestNGMethod> getMethodsDependedUpon(ITestNGMethod method, ITestNGMethod[] methods) {
diff --git a/src/main/java/org/testng/internal/MethodInheritance.java b/src/main/java/org/testng/internal/MethodInheritance.java
index 18ea901..fe3d574 100755
--- a/src/main/java/org/testng/internal/MethodInheritance.java
+++ b/src/main/java/org/testng/internal/MethodInheritance.java
@@ -1,19 +1,16 @@
 package org.testng.internal;
 
-import org.testng.ITestNGMethod;
-import org.testng.collections.Lists;
-import org.testng.collections.Maps;
-
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
+import org.testng.ITestNGMethod;
+import org.testng.collections.Lists;
+import org.testng.collections.Maps;
+
 public class MethodInheritance {
   /**
    * Look in map for a class that is a superclass of methodClass
-   * @param map
-   * @param methodClass
-   * @return
    */
   private static List<ITestNGMethod> findMethodListSuperClass(Map<Class, List<ITestNGMethod>> map,
       Class< ? extends ITestNGMethod> methodClass)
@@ -28,9 +25,6 @@ public class MethodInheritance {
 
   /**
    * Look in map for a class that is a subclass of methodClass
-   * @param map
-   * @param methodClass
-   * @return
    */
   private static Class findSubClass(Map<Class, List<ITestNGMethod>> map,
       Class< ? extends ITestNGMethod> methodClass)
diff --git a/src/main/java/org/testng/internal/PackageUtils.java b/src/main/java/org/testng/internal/PackageUtils.java
index 2703eb7..a76cbcf 100644
--- a/src/main/java/org/testng/internal/PackageUtils.java
+++ b/src/main/java/org/testng/internal/PackageUtils.java
@@ -1,8 +1,5 @@
 package org.testng.internal;
 
-import org.testng.TestNG;
-import org.testng.collections.Lists;
-
 import java.io.File;
 import java.io.FileFilter;
 import java.io.IOException;
@@ -13,12 +10,15 @@ import java.net.URL;
 import java.net.URLConnection;
 import java.net.URLDecoder;
 import java.util.Enumeration;
+import java.util.Iterator;
 import java.util.List;
+import java.util.Vector;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
 import java.util.regex.Pattern;
-import java.util.Vector;
-import java.util.Iterator;
+
+import org.testng.TestNG;
+import org.testng.collections.Lists;
 
 /**
  * Utility class that finds all the classes in a given package.
@@ -177,10 +177,6 @@ public class PackageUtils {
     return s_testClassPaths;
   }
 
-  /**
-   * @param url
-   * @return
-   */
   private static boolean matchTestClasspath(URL url, String lastFragment, boolean recursive) {
     String[] classpathFragments= getTestClasspath();
     if(null == classpathFragments) {
diff --git a/src/main/java/org/testng/internal/Parameters.java b/src/main/java/org/testng/internal/Parameters.java
index 5306f76..cd86eb8 100755
--- a/src/main/java/org/testng/internal/Parameters.java
+++ b/src/main/java/org/testng/internal/Parameters.java
@@ -37,9 +37,6 @@ import org.testng.xml.XmlTest;
  * used to invoke methods.
  *
  * @author <a href="mailto:cedric at beust.com">Cedric Beust</a>
- * @author <a href='mailto:the_mindstorm[at]evolva[dot]ro'>Alexandru Popescu</a>
- *
- * @@ANNOTATIONS@@
  */
 public class Parameters {
   public static final String NULL_VALUE= "null";
@@ -64,12 +61,9 @@ public class Parameters {
    * Creates the parameters needed for the specified <tt>@Configuration</tt> <code>Method</code>.
    *
    * @param m the configuraton method
-   * @param params
    * @param currentTestMethod the current @Test method or <code>null</code> if no @Test is available (this is not
    *    only in case the configuration method is a @Before/@AfterMethod
    * @param finder the annotation finder
-   * @param xmlSuite
-   * @return
    */
   public static Object[] createConfigurationParameters(Method m,
       Map<String, String> params,
@@ -116,11 +110,6 @@ public class Parameters {
   }
 
   /**
-   * @param optionalValues TODO
-   * @param finder TODO
-   * @param parameterAnnotations TODO
-   * @param m
-   * @param instance
    * @return An array of parameters suitable to invoke this method, possibly
    * picked from the property file
    */
diff --git a/src/main/java/org/testng/internal/PropertiesFile.java b/src/main/java/org/testng/internal/PropertiesFile.java
index 3708b64..584e4e1 100755
--- a/src/main/java/org/testng/internal/PropertiesFile.java
+++ b/src/main/java/org/testng/internal/PropertiesFile.java
@@ -10,7 +10,7 @@ import java.util.Properties;
  *
  * @author cbeust
  * @author Guy Korland
- * @date April 13, 2006
+ * @since April 13, 2006
  */
 public class PropertiesFile {
 
diff --git a/src/main/java/org/testng/internal/TestNGClassFinder.java b/src/main/java/org/testng/internal/TestNGClassFinder.java
index 8b94c25..8ccbe42 100644
--- a/src/main/java/org/testng/internal/TestNGClassFinder.java
+++ b/src/main/java/org/testng/internal/TestNGClassFinder.java
@@ -1,5 +1,12 @@
 package org.testng.internal;
 
+import java.lang.reflect.Constructor;
+import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
 import org.testng.IClass;
 import org.testng.IInstanceInfo;
 import org.testng.ITestContext;
@@ -13,13 +20,6 @@ import org.testng.internal.annotations.IAnnotationFinder;
 import org.testng.xml.XmlClass;
 import org.testng.xml.XmlTest;
 
-import java.lang.reflect.Constructor;
-import java.lang.reflect.Method;
-import java.lang.reflect.Modifier;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
 /**
  * This class creates an ITestClass from a test class.
  *
@@ -215,7 +215,7 @@ public class TestNGClassFinder extends BaseClassFinder {
   }
 
   /**
-   * @returns true if this class contains TestNG annotations (either on itself
+   * @return true if this class contains TestNG annotations (either on itself
    * or on a superclass).
    */
   public static boolean isTestNGClass(Class c, IAnnotationFinder annotationFinder) {
diff --git a/src/main/java/org/testng/internal/Utils.java b/src/main/java/org/testng/internal/Utils.java
index 099931f..19c517b 100644
--- a/src/main/java/org/testng/internal/Utils.java
+++ b/src/main/java/org/testng/internal/Utils.java
@@ -4,7 +4,6 @@ import java.io.BufferedReader;
 import java.io.BufferedWriter;
 import java.io.File;
 import java.io.FileInputStream;
-import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.FileWriter;
 import java.io.IOException;
@@ -632,10 +631,6 @@ public final class Utils {
     return buf.toString();
   }
 
-  /**
-   * @param object
-   * @return
-   */
   public static String toString(Object object, Class<?> objectClass) {
     if(null == object) {
       return "null";
@@ -652,10 +647,6 @@ public final class Utils {
     }
   }
 
-  /**
-   * @param method
-   * @return
-   */
   public static String detailedMethodName(ITestNGMethod method, boolean fqn) {
     StringBuffer buf= new StringBuffer();
     if(method.isBeforeSuiteConfiguration()) {
diff --git a/src/main/java/org/testng/internal/annotations/IBaseBeforeAfter.java b/src/main/java/org/testng/internal/annotations/IBaseBeforeAfter.java
index 9cd66b5..6155db6 100755
--- a/src/main/java/org/testng/internal/annotations/IBaseBeforeAfter.java
+++ b/src/main/java/org/testng/internal/annotations/IBaseBeforeAfter.java
@@ -6,7 +6,7 @@ import org.testng.annotations.ITestOrConfiguration;
  * Base interface for IBeforeSuite, IAfterSuite, etc...
  *
  * @author cbeust
- * @date Jun 22, 2006
+ * @since Jun 22, 2006
  */
 public interface IBaseBeforeAfter extends ITestOrConfiguration {
   /**
diff --git a/src/main/java/org/testng/internal/junit/ArrayComparisonFailure.java b/src/main/java/org/testng/internal/junit/ArrayComparisonFailure.java
index 8a45725..294c076 100644
--- a/src/main/java/org/testng/internal/junit/ArrayComparisonFailure.java
+++ b/src/main/java/org/testng/internal/junit/ArrayComparisonFailure.java
@@ -5,7 +5,6 @@ import java.util.List;
 
 /**
  * Thrown when two array elements differ
- * @see Assert#assertArrayEquals(String, Object[], Object[])
  */
 public class ArrayComparisonFailure extends AssertionError {
 
@@ -20,7 +19,6 @@ public class ArrayComparisonFailure extends AssertionError {
      * dimension that was not equal
      * @param cause the exception that caused the array's content to fail the assertion test 
      * @param index the array position of the objects that are not equal.
-     * @see Assert#assertArrayEquals(String, Object[], Object[])
      */
     public ArrayComparisonFailure(String message, AssertionError cause, int index) {
         fMessage= message;
diff --git a/src/main/java/org/testng/internal/thread/IPooledExecutor.java b/src/main/java/org/testng/internal/thread/IPooledExecutor.java
index 67782a6..c222384 100755
--- a/src/main/java/org/testng/internal/thread/IPooledExecutor.java
+++ b/src/main/java/org/testng/internal/thread/IPooledExecutor.java
@@ -14,8 +14,5 @@ public interface IPooledExecutor {
 
   void awaitTermination(long timeout) throws InterruptedException;
 
-  /**
-   * @return
-   */
   boolean isTerminated();
 }
diff --git a/src/main/java/org/testng/remote/SuiteDispatcher.java b/src/main/java/org/testng/remote/SuiteDispatcher.java
index 65a08e6..2064792 100644
--- a/src/main/java/org/testng/remote/SuiteDispatcher.java
+++ b/src/main/java/org/testng/remote/SuiteDispatcher.java
@@ -1,5 +1,9 @@
 package org.testng.remote;
 
+import java.util.Collection;
+import java.util.List;
+import java.util.Properties;
+
 import org.testng.ISuite;
 import org.testng.ISuiteResult;
 import org.testng.ITestListener;
@@ -16,16 +20,12 @@ import org.testng.remote.adapter.RemoteResultListener;
 import org.testng.xml.XmlSuite;
 import org.testng.xml.XmlTest;
 
-import java.util.Collection;
-import java.util.List;
-import java.util.Properties;
-
 /**
  * Dispatches test suits according to the strategy defined.
  *
  *
  * @author	Guy Korland
- * @date 	April 20, 2007
+ * @since 	April 20, 2007
  */
 public class SuiteDispatcher
 {
@@ -50,9 +50,6 @@ public class SuiteDispatcher
 
 	/**
 	 * Creates a new suite dispatcher.
-	 *
-	 * @param propertiesFile
-	 * @throws Exception
 	 */
 	public SuiteDispatcher( String propertiesFile) throws TestNGException
 	{
@@ -86,11 +83,6 @@ public class SuiteDispatcher
 
 	/**
 	 * Dispatch test suites
-	 * @param suites
-	 * @param outputDir
-	 * @param javadocAnnotationFinder
-	 * @param jdkAnnotationFinder
-	 * @param testListeners
 	 * @return suites result
 	 */
 	public List<ISuite> dispatch(IConfiguration configuration,
diff --git a/src/main/java/org/testng/remote/SuiteSlave.java b/src/main/java/org/testng/remote/SuiteSlave.java
index 522efd5..be3d15f 100644
--- a/src/main/java/org/testng/remote/SuiteSlave.java
+++ b/src/main/java/org/testng/remote/SuiteSlave.java
@@ -1,5 +1,8 @@
 package org.testng.remote;
 
+import java.util.List;
+import java.util.Properties;
+
 import org.testng.ISuite;
 import org.testng.TestNG;
 import org.testng.TestNGException;
@@ -10,16 +13,12 @@ import org.testng.remote.adapter.DefaultWorkerAdapter;
 import org.testng.remote.adapter.IWorkerAdapter;
 import org.testng.xml.XmlSuite;
 
-import java.io.IOException;
-import java.util.List;
-import java.util.Properties;
-
 /**
  * Run test suits sent by the dispatcher.
  *
  *
  * @author	Guy Korland
- * @date 	April 20, 2007
+ * @since 	April 20, 2007
  */
 public class SuiteSlave
 {
@@ -37,9 +36,6 @@ public class SuiteSlave
 
 	/**
 	 * Creates a new suite dispatcher.
-	 *
-	 * @param propertiesFile
-	 * @throws Exception
 	 */
 	public SuiteSlave( String propertiesFile, TestNG testng) throws TestNGException
 	{
diff --git a/src/main/java/org/testng/remote/adapter/DefaultMastertAdapter.java b/src/main/java/org/testng/remote/adapter/DefaultMastertAdapter.java
index ee20185..70fcef7 100755
--- a/src/main/java/org/testng/remote/adapter/DefaultMastertAdapter.java
+++ b/src/main/java/org/testng/remote/adapter/DefaultMastertAdapter.java
@@ -1,5 +1,11 @@
 package org.testng.remote.adapter;
 
+import java.io.IOException;
+import java.net.Socket;
+import java.net.UnknownHostException;
+import java.util.List;
+import java.util.Properties;
+
 import org.testng.collections.Lists;
 import org.testng.internal.Utils;
 import org.testng.internal.remote.SlavePool;
@@ -7,18 +13,12 @@ import org.testng.internal.thread.ThreadUtil;
 import org.testng.remote.RemoteSuiteWorker;
 import org.testng.xml.XmlSuite;
 
-import java.io.IOException;
-import java.net.Socket;
-import java.net.UnknownHostException;
-import java.util.List;
-import java.util.Properties;
-
 /**
  * Default Master adapter, provides an adapter based on hosts file.
  *
  *
  * @author	Guy Korland
- * @date 	April 20, 2007
+ * @since 	April 20, 2007
  */
 public class DefaultMastertAdapter
 implements IMasterAdapter
diff --git a/src/main/java/org/testng/remote/adapter/DefaultWorkerAdapter.java b/src/main/java/org/testng/remote/adapter/DefaultWorkerAdapter.java
index 5153efc..4a65694 100644
--- a/src/main/java/org/testng/remote/adapter/DefaultWorkerAdapter.java
+++ b/src/main/java/org/testng/remote/adapter/DefaultWorkerAdapter.java
@@ -1,22 +1,22 @@
 package org.testng.remote.adapter;
 
-import org.testng.ISuite;
-import org.testng.internal.Utils;
-import org.testng.remote.ConnectionInfo;
-import org.testng.xml.XmlSuite;
-
 import java.io.IOException;
 import java.net.ServerSocket;
 import java.net.Socket;
 import java.util.Properties;
 
+import org.testng.ISuite;
+import org.testng.internal.Utils;
+import org.testng.remote.ConnectionInfo;
+import org.testng.xml.XmlSuite;
+
 
 /**
  * Default Slave adapter, provides an adapter based on static port.
  *
  *
  * @author	Guy Korland
- * @date 	April 20, 2007
+ * @since 	April 20, 2007
  */
 public class DefaultWorkerAdapter implements IWorkerAdapter
 {
diff --git a/src/main/java/org/testng/remote/adapter/IMasterAdapter.java b/src/main/java/org/testng/remote/adapter/IMasterAdapter.java
index 4eccc44..ebddb37 100644
--- a/src/main/java/org/testng/remote/adapter/IMasterAdapter.java
+++ b/src/main/java/org/testng/remote/adapter/IMasterAdapter.java
@@ -1,23 +1,23 @@
 package org.testng.remote.adapter;
 
-import org.testng.xml.XmlSuite;
-
 import java.io.IOException;
 import java.util.Properties;
 
+import org.testng.xml.XmlSuite;
+
 /**
  * This interface should be implemented by the Master-Slave transport adapter.
  * This interface is used by the Master to push suites and get results.
  *
  * @author Guy Korland
- * @date April 9, 2007
+ * @since April 9, 2007
  * @see IWorkerAdapter
  */
 public interface IMasterAdapter
 {
 	/**
 	 * Initializes the Master adapter.
-	 * @param properties holds the properties loaded from the remote.properties file.
+	 * @param prop holds the properties loaded from the remote.properties file.
 	 * @throws Exception adapter might throw any exception on initialization, which will abort this adapter.
 	 */
 	void init( Properties prop) throws Exception;
diff --git a/src/main/java/org/testng/remote/adapter/IWorkerAdapter.java b/src/main/java/org/testng/remote/adapter/IWorkerAdapter.java
index c3022ba..d1d966b 100644
--- a/src/main/java/org/testng/remote/adapter/IWorkerAdapter.java
+++ b/src/main/java/org/testng/remote/adapter/IWorkerAdapter.java
@@ -1,17 +1,17 @@
 package org.testng.remote.adapter;
 
-import org.testng.ISuite;
-import org.testng.xml.XmlSuite;
-
 import java.io.IOException;
 import java.util.Properties;
 
+import org.testng.ISuite;
+import org.testng.xml.XmlSuite;
+
 /**
  * This interface should be implemented by the Master-Slave transport adapter.
  * This interface is used by the Slave to pull suites and return results.
  *
  * @author	Guy Korland
- * @date April 9, 2007
+ * @since April 9, 2007
  * @see IMasterAdapter
  */
 public interface IWorkerAdapter
diff --git a/src/main/java/org/testng/remote/adapter/RemoteResultListener.java b/src/main/java/org/testng/remote/adapter/RemoteResultListener.java
index f857292..7895423 100644
--- a/src/main/java/org/testng/remote/adapter/RemoteResultListener.java
+++ b/src/main/java/org/testng/remote/adapter/RemoteResultListener.java
@@ -6,19 +6,19 @@
 
 package org.testng.remote.adapter;
 
+import java.util.Map;
+
 import org.testng.ISuite;
 import org.testng.ISuiteResult;
 import org.testng.ITestContext;
 import org.testng.SuiteRunner;
 import org.testng.reporters.TestHTMLReporter;
 
-import java.util.Map;
-
 /**
  * This listener is called by the {@link IWorkerAdapter} implementation when a remote test result is ready.
  *
  * @author Guy Korland
- * @date April 9, 2007
+ * @since April 9, 2007
  * @see IWorkerAdapter
  */
 public class RemoteResultListener
diff --git a/src/main/java/org/testng/remote/strprotocol/BaseMessageSender.java b/src/main/java/org/testng/remote/strprotocol/BaseMessageSender.java
index e8f55a6..d5bf5f1 100644
--- a/src/main/java/org/testng/remote/strprotocol/BaseMessageSender.java
+++ b/src/main/java/org/testng/remote/strprotocol/BaseMessageSender.java
@@ -1,8 +1,5 @@
 package org.testng.remote.strprotocol;
 
-import org.testng.TestNGException;
-import org.testng.remote.RemoteTestNG;
-
 import java.io.BufferedReader;
 import java.io.BufferedWriter;
 import java.io.IOException;
@@ -17,6 +14,9 @@ import java.net.ServerSocket;
 import java.net.Socket;
 import java.net.SocketTimeoutException;
 
+import org.testng.TestNGException;
+import org.testng.remote.RemoteTestNG;
+
 abstract public class BaseMessageSender implements IMessageSender {
   private boolean m_debug = false;
   protected Socket m_clientSocket;
@@ -47,7 +47,6 @@ abstract public class BaseMessageSender implements IMessageSender {
   /**
    * Starts the connection.
    *
-   * @return <TT>true</TT> if the connection was successful, <TT>false</TT> otherwise
    * @throws TestNGException if an exception occurred while establishing the connection
    */
   @Override
diff --git a/src/main/java/org/testng/remote/strprotocol/GenericMessage.java b/src/main/java/org/testng/remote/strprotocol/GenericMessage.java
index 8422ac4..8c23ea0 100755
--- a/src/main/java/org/testng/remote/strprotocol/GenericMessage.java
+++ b/src/main/java/org/testng/remote/strprotocol/GenericMessage.java
@@ -56,9 +56,6 @@ public class GenericMessage implements IStringMessage {
 //    return (String) m_properties.get(propName);
 //  }
 
-  /**
-   * @see net.noco.testng.runner.IStringMessage#getMessageAsString()
-   */
   @Override
   public String getMessageAsString() {
     StringBuffer buf = new StringBuffer();
diff --git a/src/main/java/org/testng/remote/strprotocol/IRemoteSuiteListener.java b/src/main/java/org/testng/remote/strprotocol/IRemoteSuiteListener.java
index 3ef8282..8e97308 100755
--- a/src/main/java/org/testng/remote/strprotocol/IRemoteSuiteListener.java
+++ b/src/main/java/org/testng/remote/strprotocol/IRemoteSuiteListener.java
@@ -20,7 +20,7 @@ public interface IRemoteSuiteListener {
   /**
    * @see org.testng.ISuiteListener#onStart(org.testng.ISuite)
    *
-   * @param sm the suite message containing the description of the suite to be run.
+   * @param suiteMessage the suite message containing the description of the suite to be run.
    */
   void onStart(SuiteMessage suiteMessage);
 
diff --git a/src/main/java/org/testng/remote/strprotocol/MessageHub.java b/src/main/java/org/testng/remote/strprotocol/MessageHub.java
index 920dcef..30f2a50 100755
--- a/src/main/java/org/testng/remote/strprotocol/MessageHub.java
+++ b/src/main/java/org/testng/remote/strprotocol/MessageHub.java
@@ -1,12 +1,12 @@
 package org.testng.remote.strprotocol;
 
 
-import org.testng.TestNGException;
-import org.testng.remote.RemoteTestNG;
-
 import java.io.IOException;
 import java.net.SocketTimeoutException;
 
+import org.testng.TestNGException;
+import org.testng.remote.RemoteTestNG;
+
 /**
  * Central class to connect to the host and send message.
  *
@@ -25,7 +25,6 @@ public class MessageHub {
   /**
    * Starts the connection.
    *
-   * @return <TT>true</TT> if the connection was successful, <TT>false</TT> otherwise
    * @throws TestNGException if an exception occurred while establishing the connection
    */
   public void connect() throws IOException {
diff --git a/src/main/java/org/testng/remote/strprotocol/SuiteMessage.java b/src/main/java/org/testng/remote/strprotocol/SuiteMessage.java
index ee820da..f568f95 100755
--- a/src/main/java/org/testng/remote/strprotocol/SuiteMessage.java
+++ b/src/main/java/org/testng/remote/strprotocol/SuiteMessage.java
@@ -1,14 +1,14 @@
 package org.testng.remote.strprotocol;
 
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+
 import org.testng.ISuite;
 import org.testng.ITestNGMethod;
 import org.testng.collections.Lists;
 import org.testng.collections.Maps;
 
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-
 
 /**
  * A <code>IStringMessage</code> implementation for suite running events.
@@ -69,9 +69,6 @@ public class SuiteMessage implements IStringMessage {
     return m_testMethodCount;
   }
 
-  /**
-   * @see net.noco.testng.runner.IStringMessage#getMessageAsString()
-   */
   @Override
   public String getMessageAsString() {
     StringBuffer buf = new StringBuffer();
diff --git a/src/main/java/org/testng/remote/strprotocol/TestMessage.java b/src/main/java/org/testng/remote/strprotocol/TestMessage.java
index cc4f774..01e5ba5 100755
--- a/src/main/java/org/testng/remote/strprotocol/TestMessage.java
+++ b/src/main/java/org/testng/remote/strprotocol/TestMessage.java
@@ -51,9 +51,6 @@ public class TestMessage implements IStringMessage {
     return m_testStart;
   }
 
-  /**
-   * @see net.noco.testng.runner.IStringMessage#getMessageAsString()
-   */
   @Override
   public String getMessageAsString() {
     StringBuffer buf = new StringBuffer();
diff --git a/src/main/java/org/testng/remote/strprotocol/TestResultMessage.java b/src/main/java/org/testng/remote/strprotocol/TestResultMessage.java
index 6c9bf95..37a3fba 100755
--- a/src/main/java/org/testng/remote/strprotocol/TestResultMessage.java
+++ b/src/main/java/org/testng/remote/strprotocol/TestResultMessage.java
@@ -1,15 +1,15 @@
 package org.testng.remote.strprotocol;
 
-import static org.testng.internal.Utils.isStringEmpty;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.List;
 
 import org.testng.ITestContext;
 import org.testng.ITestResult;
 import org.testng.SkipException;
 import org.testng.collections.Lists;
 
-import java.io.PrintWriter;
-import java.io.StringWriter;
-import java.util.List;
+import static org.testng.internal.Utils.isStringEmpty;
 
 
 /**
@@ -398,10 +398,6 @@ public class TestResultMessage implements IStringMessage {
     return result.toArray(new String[result.size()]);
   }
 
-  /**
-   * @param params
-   * @return
-   */
   private String[] extractParamTypes(String[] params) {
     List<String> result= Lists.newArrayList(params.length);
     for(String s: params) {
diff --git a/src/main/java/org/testng/reporters/XMLConstants.java b/src/main/java/org/testng/reporters/XMLConstants.java
index d5d3405..08cdcca 100755
--- a/src/main/java/org/testng/reporters/XMLConstants.java
+++ b/src/main/java/org/testng/reporters/XMLConstants.java
@@ -4,9 +4,6 @@ package org.testng.reporters;
  * interface groups the XML constants
  * tries to emulate what's in org.apache.tools.ant.taskdefs.optional.junit.XMLConstants
  * to be compatible with junitreport
- *
- * @see org.apache.tools.ant.taskdefs.optional.junit.XMLConstants
- * @see org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter
  */
 public interface XMLConstants {
   /** the testsuites element for the aggregate document */
diff --git a/src/main/java/org/testng/reporters/XMLStringBuffer.java b/src/main/java/org/testng/reporters/XMLStringBuffer.java
index 2ef53ba..281daff 100755
--- a/src/main/java/org/testng/reporters/XMLStringBuffer.java
+++ b/src/main/java/org/testng/reporters/XMLStringBuffer.java
@@ -1,12 +1,12 @@
 package org.testng.reporters;
 
-import org.testng.internal.Nullable;
-
 import java.io.Writer;
 import java.util.Properties;
 import java.util.Stack;
 import java.util.regex.Pattern;
 
+import org.testng.internal.Nullable;
+
 /**
  * This class allows you to generate an XML text document by pushing
  * and popping tags from a stack maintained internally.
@@ -29,11 +29,6 @@ public class XMLStringBuffer {
   /** A string of space character representing the current indentation. */
   private String m_currentIndent = "";
 
-  /**
-   * @param start A string of spaces indicating the indentation at which
-   * to start the generation. Note that this constructor will also insert
-   * an <?xml prologue with a default encoding
-   */
   public XMLStringBuffer() {
     init(Buffer.create(), "", "1.0", "UTF-8");
   }
diff --git a/src/main/java/org/testng/util/RetryAnalyzerCount.java b/src/main/java/org/testng/util/RetryAnalyzerCount.java
index 44bee11..03949ff 100755
--- a/src/main/java/org/testng/util/RetryAnalyzerCount.java
+++ b/src/main/java/org/testng/util/RetryAnalyzerCount.java
@@ -1,10 +1,10 @@
 package org.testng.util;
 
+import java.util.concurrent.atomic.AtomicInteger;
+
 import org.testng.IRetryAnalyzer;
 import org.testng.ITestResult;
 
-import java.util.concurrent.atomic.AtomicInteger;
-
 /**
  * An implementation of IRetryAnalyzer that allows you to specify
  * the maximum number of times you want your test to be retried.
@@ -18,7 +18,6 @@ public abstract class RetryAnalyzerCount implements IRetryAnalyzer {
 
   /**
    * Set the max number of time the method needs to be retried.
-   * @param count
    */
   protected void setCount(int count) {
     this.count.set(count);
@@ -26,7 +25,6 @@ public abstract class RetryAnalyzerCount implements IRetryAnalyzer {
 
   /**
    * Return the current counter value
-   * @return
    */
   protected int getCount(){
       return this.count.get();
diff --git a/src/main/java/org/testng/xml/XMLParser.java b/src/main/java/org/testng/xml/XMLParser.java
index 97ea8c8..9e59430 100644
--- a/src/main/java/org/testng/xml/XMLParser.java
+++ b/src/main/java/org/testng/xml/XMLParser.java
@@ -1,16 +1,17 @@
 package org.testng.xml;
 
-import org.testng.TestNGException;
-import org.testng.internal.ClassHelper;
-import org.xml.sax.SAXException;
-import org.xml.sax.helpers.DefaultHandler;
+import java.io.IOException;
+import java.io.InputStream;
 
 import javax.xml.parsers.FactoryConfigurationError;
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.parsers.SAXParser;
 import javax.xml.parsers.SAXParserFactory;
-import java.io.IOException;
-import java.io.InputStream;
+
+import org.testng.TestNGException;
+import org.testng.internal.ClassHelper;
+import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
 
 abstract public class XMLParser<T> implements IFileParser<T> {
 
@@ -90,8 +91,6 @@ abstract public class XMLParser<T> implements IFileParser<T> {
 
   /**
    * Tests if the current <code>SAXParserFactory</code> supports DTD validation.
-   * @param spf
-   * @return
    */
   private static boolean supportsValidation(SAXParserFactory spf) {
     try {

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/testng.git



More information about the pkg-java-commits mailing list