[java-support] branch master updated: JPAR-131 - Fix doclint issues in test javadoc

Ian Young ian at iay.org.uk
Fri Dec 20 12:19:57 EST 2019


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

iay pushed a commit to branch master
in repository java-support.

View the commit online:
http://git.shibboleth.net/view/?p=java-support.git;a=commit;h=5a3da165c58290af0d5270a793dd404dc4cd97e8

The following commit(s) were added to refs/heads/master by this push:
       new  5a3da16   JPAR-131 - Fix doclint issues in test javadoc
5a3da16 is described below

commit 5a3da165c58290af0d5270a793dd404dc4cd97e8
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Fri Dec 20 17:19:53 2019 +0000

    JPAR-131 - Fix doclint issues in test javadoc
    
    https://issues.shibboleth.net/jira/browse/JPAR-131
---
 .../support/collection/ClassIndexedSetTest.java    |   8 +-
 .../java/support/collection/ListTest.java          |   4 +-
 ...stractIdentifiedInitializableComponentTest.java |  12 +-
 .../AbstractInitializableComponentTest.java        |   6 +-
 .../net/SameSiteCookieHeaderFilterTest.java        |  69 ++-
 .../utilities/java/support/net/URLBuilderTest.java |  16 +-
 .../support/resource/TestResourceConverter.java    |   5 +-
 ...cureRandomIdentifierGenerationStrategyTest.java |   2 +-
 .../support/testing/ShowAutomaticModuleNames.java  |   5 +-
 .../java/support/xml/BasicParserPoolTest.java      |  25 +-
 .../java/support/xml/XMLAssertTestNG.java          | 515 +++++++++++----------
 11 files changed, 369 insertions(+), 298 deletions(-)

diff --git a/src/test/java/net/shibboleth/utilities/java/support/collection/ClassIndexedSetTest.java b/src/test/java/net/shibboleth/utilities/java/support/collection/ClassIndexedSetTest.java
index 1957a6d..f04a918 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/collection/ClassIndexedSetTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/collection/ClassIndexedSetTest.java
@@ -290,7 +290,7 @@ public class ClassIndexedSetTest {
         /**
          * Constructor.
          * 
-         * @param newData
+         * @param newData data to store
          */
         public A(String newData) {
             super(newData);
@@ -303,7 +303,7 @@ public class ClassIndexedSetTest {
         /**
          * Constructor.
          * 
-         * @param newData
+         * @param newData data to store
          */
         public B(String newData) {
             super(newData);
@@ -316,7 +316,7 @@ public class ClassIndexedSetTest {
         /**
          * Constructor.
          * 
-         * @param newData
+         * @param newData data to store
          */
         public C(String newData) {
             super(newData);
@@ -329,7 +329,7 @@ public class ClassIndexedSetTest {
         /**
          * Constructor.
          * 
-         * @param newData
+         * @param newData data to store
          */
         public D(String newData) {
             super(newData);
diff --git a/src/test/java/net/shibboleth/utilities/java/support/collection/ListTest.java b/src/test/java/net/shibboleth/utilities/java/support/collection/ListTest.java
index bcf2548..f77ae4e 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/collection/ListTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/collection/ListTest.java
@@ -35,7 +35,9 @@ public class ListTest {
         testListIterator(new ArrayList<String>());
     }
     /**
-     * Test those things that distinguish the {@link List} API from the {@link java.util.Collection} one. 
+     * Test those things that distinguish the {@link List} API from the {@link java.util.Collection} one.
+     * 
+     * @param list list to test
      */
     public static void testListFunctions(List<String> list) {
         boolean thrown = false;
diff --git a/src/test/java/net/shibboleth/utilities/java/support/component/AbstractIdentifiedInitializableComponentTest.java b/src/test/java/net/shibboleth/utilities/java/support/component/AbstractIdentifiedInitializableComponentTest.java
index 844f2b9..581bada 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/component/AbstractIdentifiedInitializableComponentTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/component/AbstractIdentifiedInitializableComponentTest.java
@@ -25,7 +25,11 @@ import org.testng.annotations.Test;
 /** Test for {@link AbstractIdentifiedInitializableComponent}. */
 public class AbstractIdentifiedInitializableComponentTest {
 
-    /** Test setting and retrieving the component's ID. */
+    /**
+     * Test setting and retrieving the component's ID.
+     * 
+     * @throws Exception if something bad happens
+     */
     @Test public void testId() throws Exception {
         MockComponent component = new MockComponent();
         Assert.assertNull(component.getId());
@@ -65,7 +69,11 @@ public class AbstractIdentifiedInitializableComponentTest {
         }
     }
 
-    /** Tests initializing the component. */
+    /**
+     * Tests initializing the component.
+     * 
+     * @throws Exception if something bad happens
+     */
     @Test public void testInitialization() throws Exception {
         MockComponent component = new MockComponent();
         Assert.assertFalse(component.isInitialized());
diff --git a/src/test/java/net/shibboleth/utilities/java/support/component/AbstractInitializableComponentTest.java b/src/test/java/net/shibboleth/utilities/java/support/component/AbstractInitializableComponentTest.java
index d00f44d..2dd0146 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/component/AbstractInitializableComponentTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/component/AbstractInitializableComponentTest.java
@@ -25,7 +25,11 @@ import org.testng.annotations.Test;
  */
 public class AbstractInitializableComponentTest {
 
-    /** Tests initializing the component. */
+    /**
+     * Tests initializing the component.
+     * 
+     * @throws Exception if something bad happens
+     */
     @Test public void testInitialization() throws Exception {
         MockComponent component = new MockComponent();
         Assert.assertFalse(component.isInitialized());
diff --git a/src/test/java/net/shibboleth/utilities/java/support/net/SameSiteCookieHeaderFilterTest.java b/src/test/java/net/shibboleth/utilities/java/support/net/SameSiteCookieHeaderFilterTest.java
index 6e8b7fc..bd1b2be 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/net/SameSiteCookieHeaderFilterTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/net/SameSiteCookieHeaderFilterTest.java
@@ -132,8 +132,13 @@ public class SameSiteCookieHeaderFilterTest {
         filter.setSameSiteCookies(cookies);
     }
     
-    /** Test empty SameSite cookie map, which should not trigger an exception, and just copy over the
-     * existing cookies. */
+    /**
+     * Test empty SameSite cookie map, which should not trigger an exception, and just copy over the
+     * existing cookies.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testEmptySameSiteCookieMap() throws IOException, ServletException {
         
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
@@ -151,8 +156,13 @@ public class SameSiteCookieHeaderFilterTest {
         Assert.assertEquals(headers.size(), 5);
     }
 
-    /** Test empty SameSite cookie map and Null default, which should not trigger an exception, and just copy over the
-     * existing cookies. */
+    /**
+     * Test empty SameSite cookie map and Null default, which should not trigger an exception, and just copy over the
+     * existing cookies.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testEmptySameSiteCookieMapAndNullDefault() throws IOException, ServletException {
         
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
@@ -171,8 +181,13 @@ public class SameSiteCookieHeaderFilterTest {
         Assert.assertEquals(headers.size(), 5);
     }
 
-    /** Test empty SameSite cookie map, which should not trigger an exception, and should apply
-     * a default. */
+    /**
+     * Test empty SameSite cookie map, which should not trigger an exception, and should apply
+     * a default.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testEmptySameSiteCookieMapWithDefault() throws IOException, ServletException {
         
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
@@ -195,7 +210,12 @@ public class SameSiteCookieHeaderFilterTest {
                 Collections.emptyList(), 5);
     }
 
-    /** Test the samesite filter works correctly with None values when a redirect response is issued. */
+    /**
+     * Test the samesite filter works correctly with None values when a redirect response is issued.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testRedirectResponseSameSiteNone() throws IOException, ServletException {
        
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
@@ -216,7 +236,12 @@ public class SameSiteCookieHeaderFilterTest {
                 List.of(new String[] {"ignore_copy_over"}),5);
     }
 
-    /** Test the samesite filter works correctly with None values when a redirect response is issued. */
+    /**
+     * Test the samesite filter works correctly with None values when a redirect response is issued.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testRedirectResponseSameSiteNoneWithDefault() throws IOException, ServletException {
        
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
@@ -238,7 +263,12 @@ public class SameSiteCookieHeaderFilterTest {
                 Collections.emptyList(), 5);
     }
     
-    /** Test the samesite filter works correctly with Lax values when a redirect response is issued. */
+    /**
+     * Test the samesite filter works correctly with Lax values when a redirect response is issued.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testRedirectResponseSameSiteLax() throws IOException, ServletException {
        
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
@@ -260,7 +290,12 @@ public class SameSiteCookieHeaderFilterTest {
                 List.of(new String[] {"ignore_copy_over"}),5);
     }
     
-    /** Test the samesite filter works correctly with Strict values when a redirect response is issued. */
+    /**
+     * Test the samesite filter works correctly with Strict values when a redirect response is issued.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testRedirectResponseSameSiteStrict() throws IOException, ServletException {
         
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
@@ -282,7 +317,12 @@ public class SameSiteCookieHeaderFilterTest {
                 List.of(new String[] {"ignore_copy_over"}),5);
     }
 
-    /** Test the samesite filter works correctly when an output stream is written to and flushed. */
+    /**
+     * Test the samesite filter works correctly when an output stream is written to and flushed.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testGetOutputStreamResponse() throws IOException, ServletException {
         
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
@@ -303,7 +343,12 @@ public class SameSiteCookieHeaderFilterTest {
                 List.of(new String[] {"ignore_copy_over"}),5);
     }
     
-    /** Test the samesite filter works correctly when the response print writer is written to and closed.*/
+    /**
+     * Test the samesite filter works correctly when the response print writer is written to and closed.
+     * 
+     * @throws IOException if something bad happens
+     * @throws ServletException if something bad happens
+     */
     @Test public void testPrintWriterResponse() throws IOException, ServletException {
         
         SameSiteCookieHeaderFilter filter = new SameSiteCookieHeaderFilter();
diff --git a/src/test/java/net/shibboleth/utilities/java/support/net/URLBuilderTest.java b/src/test/java/net/shibboleth/utilities/java/support/net/URLBuilderTest.java
index c96004c..5a19b74 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/net/URLBuilderTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/net/URLBuilderTest.java
@@ -32,7 +32,7 @@ public class URLBuilderTest {
     
     /**
      * Test with scheme and host.
-     * @throws MalformedURLException 
+     * @throws MalformedURLException if the URL is malformed
      */
     @Test
     public void testURLBuilder1() throws MalformedURLException{
@@ -52,7 +52,7 @@ public class URLBuilderTest {
     
     /**
      * Test with scheme, host, and path.
-     * @throws MalformedURLException 
+     * @throws MalformedURLException if the URL is malformed
      */
     @Test
     public void testURLBuilder2() throws MalformedURLException{
@@ -72,7 +72,7 @@ public class URLBuilderTest {
     
     /**
      * Test with scheme, host, port, path, and query params.
-     * @throws MalformedURLException 
+     * @throws MalformedURLException if the URL is malformed
      */
     @Test
     public void testURLBuilder3() throws MalformedURLException{
@@ -92,7 +92,7 @@ public class URLBuilderTest {
     
     /**
      * Test with some odd values.
-     * @throws MalformedURLException 
+     * @throws MalformedURLException if the URL is malformed
      */
     @Test
     public void testValues() throws MalformedURLException{
@@ -116,7 +116,7 @@ public class URLBuilderTest {
     
     /**
      * Test with scheme, host, and fragment.
-     * @throws MalformedURLException 
+     * @throws MalformedURLException if the URL is malformed
      */
     @Test
     public void testURLBuilder4() throws MalformedURLException{
@@ -136,7 +136,7 @@ public class URLBuilderTest {
 
     /**
      * Test with scheme, host, port, path, query params, and anchor.
-     * @throws MalformedURLException 
+     * @throws MalformedURLException if the URL is malformed
      */
     @Test
     public void testURLBuilder5() throws MalformedURLException{
@@ -156,7 +156,7 @@ public class URLBuilderTest {
     
     /**
      * Test with scheme, username, password, and host.
-     * @throws MalformedURLException 
+     * @throws MalformedURLException if the URL is malformed
      */
     @Test
     public void testURLBuilder6() throws MalformedURLException{
@@ -176,7 +176,7 @@ public class URLBuilderTest {
     
     /**
      * Test with scheme, username, and host.
-     * @throws MalformedURLException 
+     * @throws MalformedURLException if the URL is malformed
      */
     @Test
     public void testURLBuilder7() throws MalformedURLException{
diff --git a/src/test/java/net/shibboleth/utilities/java/support/resource/TestResourceConverter.java b/src/test/java/net/shibboleth/utilities/java/support/resource/TestResourceConverter.java
index de08cf7..6106709 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/resource/TestResourceConverter.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/resource/TestResourceConverter.java
@@ -48,9 +48,12 @@ public final class TestResourceConverter implements net.shibboleth.utilities.jav
     }
 
     /**
-     * Return a {@link Resource} that does all the work of the provided {@link Resource}<br/>
+     * Return a {@link Resource} that does all the work of the provided {@link Resource}.
+     * 
+     * <p>
      * If the input implements {@link Resource} then it is cast to the output, other a shim class is
      * generated.
+     * </p>
      * 
      * @param springResource the input
      * @return a {@link Resource} which reflects what the Spring one does
diff --git a/src/test/java/net/shibboleth/utilities/java/support/security/SecureRandomIdentifierGenerationStrategyTest.java b/src/test/java/net/shibboleth/utilities/java/support/security/SecureRandomIdentifierGenerationStrategyTest.java
index 8134e89..35cd3a4 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/security/SecureRandomIdentifierGenerationStrategyTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/security/SecureRandomIdentifierGenerationStrategyTest.java
@@ -63,7 +63,7 @@ public class SecureRandomIdentifierGenerationStrategyTest {
      * Test generateIdentifier by generating a large number of identifiers and seeing whether each one is a valid XML
      * ID, and that they are all different.
      * 
-     * @throws NoSuchAlgorithmException
+     * @throws NoSuchAlgorithmException if the SHA1PRNG algorithm is not available
      */
     @Test public void testConstructorWithSecureRandom() throws NoSuchAlgorithmException {
         final Pattern ncNamePattern = Pattern.compile("^[a-zA-Z_][a-zA-Z0-9_\\-\\.]+$");
diff --git a/src/test/java/net/shibboleth/utilities/java/support/testing/ShowAutomaticModuleNames.java b/src/test/java/net/shibboleth/utilities/java/support/testing/ShowAutomaticModuleNames.java
index 2d98f1a..05bfad3 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/testing/ShowAutomaticModuleNames.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/testing/ShowAutomaticModuleNames.java
@@ -75,6 +75,7 @@ public class ShowAutomaticModuleNames {
      *
      * @param jarFile <code>.jar</code> file to process
      * @return the automatic module name, or <code>null</code>
+     * @throws TerminationException if something goes wrong
      */
     @Nullable
     private String getAutomaticModuleName(@Nonnull JarFile jarFile) throws TerminationException {
@@ -92,8 +93,8 @@ public class ShowAutomaticModuleNames {
      * Process all of the <code>.jar</code> files in a given directory, and present
      * the results in a readable way.
      *
-     * @param directory
-     * @throws TerminationException
+     * @param directory directory to process
+     * @throws TerminationException if something goes wrong
      */
     private void runDirectory(@Nonnull final File directory) throws TerminationException {
         System.out.println("Processing directory: " + directory.getAbsolutePath());
diff --git a/src/test/java/net/shibboleth/utilities/java/support/xml/BasicParserPoolTest.java b/src/test/java/net/shibboleth/utilities/java/support/xml/BasicParserPoolTest.java
index a4d4884..bb18e49 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/xml/BasicParserPoolTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/xml/BasicParserPoolTest.java
@@ -582,14 +582,13 @@ public class BasicParserPoolTest {
      * Test issue reported in JXT-46 - a parser should not be checked into the pool multiple times
      * via the auto-checkin mechanism by the proxy finalize().
      * 
-     * @throws XMLParserException 
-     * @throws ComponentInitializationException 
-     * @throws InterruptedException 
+     * @throws XMLParserException if something bad happens
+     * @throws ComponentInitializationException if something bad happens
      */
     @Test
     public void testFinalize() throws XMLParserException, ComponentInitializationException {
-BasicParserPool pool = new BasicParserPool();
-pool.initialize();
+        BasicParserPool pool = new BasicParserPool();
+        pool.initialize();
         Assert.assertEquals(0, pool.getPoolSize());
         
         // Check out and return a builder
@@ -631,8 +630,8 @@ pool.initialize();
     /**
      * Test for caller (illegally) returning a builder multiple times to pool.
      * 
-     * @throws XMLParserException
-     * @throws ComponentInitializationException 
+     * @throws XMLParserException if something bad happens
+     * @throws ComponentInitializationException if something bad happens
      */
     @Test
     public void testExplicitMultipleReturn() throws XMLParserException, ComponentInitializationException {
@@ -660,11 +659,9 @@ pool.initialize();
     /**
      * Test for a caller illegally using a parser proxy after it has been returned. 
      * 
-     * @throws XMLParserException 
-     * @throws URISyntaxException 
-     * @throws ComponentInitializationException 
-     * @throws IOException 
-     * 
+     * @throws XMLParserException if something bad happens
+     * @throws URISyntaxException if something bad happens
+     * @throws ComponentInitializationException if something bad happens
      */
     @Test
     public void testParserUseAfterReturn() throws XMLParserException, URISyntaxException, ComponentInitializationException {
@@ -738,8 +735,8 @@ pool.initialize();
     /**
      * Test that only maxPoolSize parsers are ever cached.
      * 
-     * @throws XMLParserException
-     * @throws ComponentInitializationException 
+     * @throws XMLParserException if something bad happens
+     * @throws ComponentInitializationException if something bad happens
      */
     @Test
     public void testMaxPoolSize() throws XMLParserException, ComponentInitializationException {
diff --git a/src/test/java/net/shibboleth/utilities/java/support/xml/XMLAssertTestNG.java b/src/test/java/net/shibboleth/utilities/java/support/xml/XMLAssertTestNG.java
index 4e8ac97..6656e21 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/xml/XMLAssertTestNG.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/xml/XMLAssertTestNG.java
@@ -66,43 +66,53 @@ import org.xml.sax.SAXException;
  * inheriting from and using JUnit's Assert class, it instead uses TestNG's {@link org.testng.Assert}.
  * </p>
  * 
+ * <p>
  * Collection of static methods so that XML assertion facilities are available in any class, not just test suites.
- * Thanks to Andrew McCormick and others for suggesting this refactoring.<br/>
- * Available assertion methods are:
+ * Thanks to Andrew McCormick and others for suggesting this refactoring.
+ * </p>
+ * 
+ * <p>Available assertion methods are:</p>
+ * 
  * <ul>
- * <li><strong><code>assertXMLEqual</code></strong><br/>
+ * <li><strong><code>assertXMLEqual</code></strong>:
  * assert that two pieces of XML markup are <i>similar</i></li>
- * <li><strong><code>assertXMLNotEqual</code></strong><br/>
+ * <li><strong><code>assertXMLNotEqual</code></strong>:
  * assert that two pieces of XML markup are <i>different</i></li>
- * <li><strong><code>assertXMLIdentical</code></strong><br/>
+ * <li><strong><code>assertXMLIdentical</code></strong>:
  * assert that two pieces of XML markup are <i>identical</i>. In most cases this assertion is too strong and
  * <code>assertXMLEqual</code> is sufficient</li>
- * <li><strong><code>assertXpathExists</code></strong><br/>
+ * <li><strong><code>assertXpathExists</code></strong>:
  * assert that an XPath expression matches at least one node</li>
- * <li><strong><code>assertXpathNotExists</code></strong><br/>
+ * <li><strong><code>assertXpathNotExists</code></strong>:
  * assert that an XPath expression does not match any nodes</li>
- * <li><strong><code>assertXpathsEqual</code></strong><br/>
+ * <li><strong><code>assertXpathsEqual</code></strong>:
  * assert that the nodes obtained by executing two Xpaths are <i>similar</i></li>
- * <li><strong><code>assertXpathsNotEqual</code></strong><br/>
+ * <li><strong><code>assertXpathsNotEqual</code></strong>:
  * assert that the nodes obtained by executing two Xpaths are <i>different</i></li>
- * <li><strong><code>assertXpathValuesEqual</code></strong><br/>
+ * <li><strong><code>assertXpathValuesEqual</code></strong>:
  * assert that the flattened String obtained by executing two Xpaths are <i>similar</i></li>
- * <li><strong><code>assertXpathValuesNotEqual</code></strong><br/>
+ * <li><strong><code>assertXpathValuesNotEqual</code></strong>:
  * assert that the flattened String obtained by executing two Xpaths are <i>different</i></li>
- * <li><strong><code>assertXpathEvaluatesTo</code></strong><br/>
+ * <li><strong><code>assertXpathEvaluatesTo</code></strong>:
  * assert that the flattened String obtained by executing an Xpath is a particular value</li>
- * <li><strong><code>assertXMLValid</code></strong><br/>
+ * <li><strong><code>assertXMLValid</code></strong>:
  * assert that a piece of XML markup is valid with respect to a DTD: either by using the markup's own DTD or a different
  * DTD</li>
- * <li><strong><code>assertNodeTestPasses</code></strong><br/>
+ * <li><strong><code>assertNodeTestPasses</code></strong>:
  * assert that a piece of XML markup passes a {@link NodeTest NodeTest}</li>
  * </ul>
+ * 
+ * <p>
  * All underlying similarity and difference testing is done using {@link Diff Diff} instances which can be instantiated
  * and evaluated independently of this class.
+ * </p>
  * 
  * @see Diff#similar()
- * @see Diff#identical() <br />
- *      Examples and more at <a href="http://xmlunit.sourceforge.net"/>xmlunit.sourceforge.net</a>
+ * @see Diff#identical()
+ * 
+ * <p>
+ * Examples and more at <a href="http://xmlunit.sourceforge.net">xmlunit.sourceforge.net</a>
+ * </p>
  */
 public class XMLAssertTestNG implements XSLTConstants {
 
@@ -169,8 +179,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * 
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLEqual(InputSource control, InputSource test) throws SAXException, IOException {
         assertXMLEqual(null, control, test);
@@ -181,8 +191,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * 
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLEqual(String control, String test) throws SAXException, IOException {
         assertXMLEqual(null, control, test);
@@ -203,8 +213,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * 
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLEqual(Reader control, Reader test) throws SAXException, IOException {
         assertXMLEqual(null, control, test);
@@ -216,8 +226,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * @param err Message to be displayed on assertion failure
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLEqual(String err, InputSource control, InputSource test) throws SAXException,
             IOException {
@@ -231,8 +241,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * @param err Message to be displayed on assertion failure
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLEqual(String err, String control, String test) throws SAXException, IOException {
         Diff diff = new Diff(control, test);
@@ -257,8 +267,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * @param err Message to be displayed on assertion failure
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLEqual(String err, Reader control, Reader test) throws SAXException, IOException {
         Diff diff = new Diff(control, test);
@@ -270,8 +280,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * 
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLNotEqual(InputSource control, InputSource test) throws SAXException, IOException {
         assertXMLNotEqual(null, control, test);
@@ -282,8 +292,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * 
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLNotEqual(String control, String test) throws SAXException, IOException {
         assertXMLNotEqual(null, control, test);
@@ -304,8 +314,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * 
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLNotEqual(Reader control, Reader test) throws SAXException, IOException {
         assertXMLNotEqual(null, control, test);
@@ -317,8 +327,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * @param err Message to be displayed on assertion failure
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLNotEqual(String err, InputSource control, InputSource test) throws SAXException,
             IOException {
@@ -332,8 +342,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * @param err Message to be displayed on assertion failure
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLNotEqual(String err, String control, String test) throws SAXException, IOException {
         Diff diff = new Diff(control, test);
@@ -358,8 +368,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * @param err Message to be displayed on assertion failure
      * @param control XML to be compared against
      * @param test XML to be tested
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertXMLNotEqual(String err, Reader control, Reader test) throws SAXException, IOException {
         Diff diff = new Diff(control, test);
@@ -369,10 +379,10 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in the same document are equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param document
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param document ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathsEqual(String controlXpath, String testXpath, Document document)
@@ -383,12 +393,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in the same document are equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param document
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param document ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathsEqual(String controlXpath, String testXpath, InputSource document)
@@ -399,12 +409,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in the same XML string are equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param inXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param inXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathsEqual(String controlXpath, String testXpath, String inXMLString)
             throws SAXException, IOException, XpathException {
@@ -414,13 +424,13 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in two documents are equal
      * 
-     * @param controlXpath
-     * @param controlDocument
-     * @param testXpath
-     * @param testDocument
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param controlDocument ...
+     * @param testXpath ...
+     * @param testDocument ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathsEqual(String controlXpath, InputSource controlDocument, String testXpath,
@@ -432,13 +442,13 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in two XML strings are equal
      * 
-     * @param controlXpath
-     * @param inControlXMLString
-     * @param testXpath
-     * @param inTestXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param inControlXMLString ...
+     * @param testXpath ...
+     * @param inTestXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathsEqual(String controlXpath, String inControlXMLString, String testXpath,
             String inTestXMLString) throws SAXException, IOException, XpathException {
@@ -449,10 +459,11 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in two documents are equal
      * 
-     * @param controlXpath
-     * @param controlDocument
-     * @param testXpath
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param controlDocument ...
+     * @param testXpath ...
+     * @param testDocument ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathsEqual(String controlXpath, Document controlDocument, String testXpath,
@@ -463,10 +474,10 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in the same document are NOT equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param document
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param document ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathsNotEqual(String controlXpath, String testXpath, Document document)
@@ -477,12 +488,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in the same document are NOT equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param document
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param document ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathsNotEqual(String controlXpath, String testXpath, InputSource document)
@@ -493,12 +504,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in the same XML string are NOT equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param inXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param inXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathsNotEqual(String controlXpath, String testXpath, String inXMLString)
             throws SAXException, IOException, XpathException {
@@ -508,13 +519,13 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in two XML strings are NOT equal
      * 
-     * @param controlXpath
-     * @param inControlXMLString
-     * @param testXpath
-     * @param inTestXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param inControlXMLString ...
+     * @param testXpath ...
+     * @param inTestXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathsNotEqual(String controlXpath, String inControlXMLString, String testXpath,
             String inTestXMLString) throws SAXException, IOException, XpathException {
@@ -525,13 +536,13 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in two XML strings are NOT equal
      * 
-     * @param controlXpath
-     * @param controlDocument
-     * @param testXpath
-     * @param testDocument
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param controlDocument ...
+     * @param testXpath ...
+     * @param testDocument ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathsNotEqual(String controlXpath, InputSource controlDocument, String testXpath,
             InputSource testDocument) throws SAXException, IOException, XpathException {
@@ -542,11 +553,11 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in two documents are NOT equal
      * 
-     * @param controlXpath
-     * @param controlDocument
-     * @param testXpath
-     * @param testDocument
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param controlDocument ...
+     * @param testXpath ...
+     * @param testDocument ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathsNotEqual(String controlXpath, Document controlDocument, String testXpath,
@@ -557,12 +568,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the node lists of two Xpaths in two documents are equal or not.
      * 
-     * @param controlXpath
-     * @param controlDocument
-     * @param testXpath
-     * @param testDocument
+     * @param controlXpath ...
+     * @param controlDocument ...
+     * @param testXpath ...
+     * @param testDocument ...
      * @param equal whether the values should be equal.
-     * @throws XpathException
+     * @throws XpathException ...
      * @see XpathEngine
      */
     private static void assertXpathEquality(String controlXpath, Document controlDocument, String testXpath,
@@ -578,10 +589,10 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in the same document are equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param document
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param document ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathValuesEqual(String controlXpath, String testXpath, Document document)
@@ -592,12 +603,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in the same XML string are equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param document
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param document ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesEqual(String controlXpath, String testXpath, InputSource document)
             throws SAXException, IOException, XpathException {
@@ -607,12 +618,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in the same XML string are equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param inXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param inXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesEqual(String controlXpath, String testXpath, String inXMLString)
             throws SAXException, IOException, XpathException {
@@ -622,13 +633,13 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in two XML strings are equal
      * 
-     * @param controlXpath
-     * @param control
-     * @param testXpath
-     * @param test
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param control ...
+     * @param testXpath ...
+     * @param test ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesEqual(String controlXpath, InputSource control, String testXpath,
             InputSource test) throws SAXException, IOException, XpathException {
@@ -639,13 +650,13 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in two XML strings are equal
      * 
-     * @param controlXpath
-     * @param inControlXMLString
-     * @param testXpath
-     * @param inTestXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param inControlXMLString ...
+     * @param testXpath ...
+     * @param inTestXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesEqual(String controlXpath, String inControlXMLString, String testXpath,
             String inTestXMLString) throws SAXException, IOException, XpathException {
@@ -656,11 +667,11 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in two documents are equal
      * 
-     * @param controlXpath
-     * @param controlDocument
-     * @param testXpath
-     * @param testDocument
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param controlDocument ...
+     * @param testXpath ...
+     * @param testDocument ...
+     * @throws XpathException ...
      * @see XpathEngine
      */
     public static void assertXpathValuesEqual(String controlXpath, Document controlDocument, String testXpath,
@@ -673,12 +684,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in the same XML string are NOT equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param control
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param control ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesNotEqual(String controlXpath, String testXpath, InputSource control)
             throws SAXException, IOException, XpathException {
@@ -688,12 +699,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in the same XML string are NOT equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param inXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param inXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesNotEqual(String controlXpath, String testXpath, String inXMLString)
             throws SAXException, IOException, XpathException {
@@ -703,10 +714,10 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in the same document are NOT equal
      * 
-     * @param controlXpath
-     * @param testXpath
-     * @param document
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param testXpath ...
+     * @param document ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesNotEqual(String controlXpath, String testXpath, Document document)
             throws XpathException {
@@ -716,13 +727,13 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in two XML strings are NOT equal
      * 
-     * @param controlXpath
-     * @param control
-     * @param testXpath
-     * @param test
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param control ...
+     * @param testXpath ...
+     * @param test ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesNotEqual(String controlXpath, InputSource control, String testXpath,
             InputSource test) throws SAXException, IOException, XpathException {
@@ -733,13 +744,13 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in two XML strings are NOT equal
      * 
-     * @param controlXpath
-     * @param inControlXMLString
-     * @param testXpath
-     * @param inTestXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param inControlXMLString ...
+     * @param testXpath ...
+     * @param inTestXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesNotEqual(String controlXpath, String inControlXMLString, String testXpath,
             String inTestXMLString) throws SAXException, IOException, XpathException {
@@ -750,11 +761,11 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that the evaluation of two Xpaths in two documents are NOT equal
      * 
-     * @param controlXpath
-     * @param controlDocument
-     * @param testXpath
-     * @param testDocument
-     * @throws XpathException
+     * @param controlXpath ...
+     * @param controlDocument ...
+     * @param testXpath ...
+     * @param testDocument ...
+     * @throws XpathException ...
      */
     public static void assertXpathValuesNotEqual(String controlXpath, Document controlDocument, String testXpath,
             Document testDocument) throws XpathException {
@@ -773,12 +784,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert the value of an Xpath expression in an XML document.
      * 
-     * @param expectedValue
-     * @param xpathExpression
-     * @param control
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param expectedValue ...
+     * @param xpathExpression ...
+     * @param control ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathEvaluatesTo(String expectedValue, String xpathExpression, InputSource control)
@@ -790,12 +801,12 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert the value of an Xpath expression in an XML String
      * 
-     * @param expectedValue
-     * @param xpathExpression
-     * @param inXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param expectedValue ...
+     * @param xpathExpression ...
+     * @param inXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathEvaluatesTo(String expectedValue, String xpathExpression, String inXMLString)
@@ -807,10 +818,10 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert the value of an Xpath expression in an DOM Document
      * 
-     * @param expectedValue
-     * @param xPathExpression
-     * @param inDocument
-     * @throws XpathException
+     * @param expectedValue ...
+     * @param xPathExpression ...
+     * @param inDocument ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathEvaluatesTo(String expectedValue, String xPathExpression, Document inDocument)
@@ -822,11 +833,11 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that a specific XPath exists in some given XML
      * 
-     * @param xPathExpression
-     * @param control
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param xPathExpression ...
+     * @param control ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathExists(String xPathExpression, InputSource control) throws IOException, SAXException,
@@ -838,11 +849,11 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that a specific XPath exists in some given XML
      * 
-     * @param xPathExpression
-     * @param inXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param xPathExpression ...
+     * @param inXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathExists(String xPathExpression, String inXMLString) throws IOException, SAXException,
@@ -854,9 +865,9 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that a specific XPath exists in some given XML
      * 
-     * @param xPathExpression
-     * @param inDocument
-     * @throws XpathException
+     * @param xPathExpression ...
+     * @param inDocument ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathExists(String xPathExpression, Document inDocument) throws XpathException {
@@ -869,11 +880,11 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that a specific XPath does NOT exist in some given XML
      * 
-     * @param xPathExpression
-     * @param control
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param xPathExpression ...
+     * @param control ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathNotExists(String xPathExpression, InputSource control) throws IOException,
@@ -885,11 +896,11 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that a specific XPath does NOT exist in some given XML
      * 
-     * @param xPathExpression
-     * @param inXMLString
-     * @throws SAXException
-     * @throws IOException
-     * @throws XpathException
+     * @param xPathExpression ...
+     * @param inXMLString ...
+     * @throws SAXException ...
+     * @throws IOException ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathNotExists(String xPathExpression, String inXMLString) throws IOException,
@@ -901,9 +912,9 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that a specific XPath does NOT exist in some given XML
      * 
-     * @param xPathExpression
-     * @param inDocument
-     * @throws XpathException
+     * @param xPathExpression ...
+     * @param inDocument ...
+     * @throws XpathException ...
      * @see XpathEngine which provides the underlying evaluation mechanism
      */
     public static void assertXpathNotExists(String xPathExpression, Document inDocument) throws XpathException {
@@ -917,8 +928,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * Assert that an InputSource containing XML contains valid XML: the document must contain a DOCTYPE declaration to
      * be validated
      * 
-     * @param xml
-     * @throws SAXException
+     * @param xml ...
+     * @throws SAXException ...
      * @throws ConfigurationException if validation could not be turned on
      * @see Validator
      */
@@ -930,8 +941,8 @@ public class XMLAssertTestNG implements XSLTConstants {
      * Assert that a String containing XML contains valid XML: the String must contain a DOCTYPE declaration to be
      * validated
      * 
-     * @param xmlString
-     * @throws SAXException
+     * @param xmlString ...
+     * @throws SAXException ...
      * @throws ConfigurationException if validation could not be turned on
      * @see Validator
      */
@@ -943,9 +954,9 @@ public class XMLAssertTestNG implements XSLTConstants {
      * Assert that an InputSource containing XML contains valid XML: the document must contain a DOCTYPE to be
      * validated, but the validation will use the systemId to obtain the DTD
      * 
-     * @param xml
-     * @param systemId
-     * @throws SAXException
+     * @param xml ...
+     * @param systemId ...
+     * @throws SAXException ...
      * @throws ConfigurationException if validation could not be turned on
      * @see Validator
      */
@@ -957,9 +968,9 @@ public class XMLAssertTestNG implements XSLTConstants {
      * Assert that a String containing XML contains valid XML: the String must contain a DOCTYPE to be validated, but
      * the validation will use the systemId to obtain the DTD
      * 
-     * @param xmlString
-     * @param systemId
-     * @throws SAXException
+     * @param xmlString ...
+     * @param systemId ...
+     * @throws SAXException ...
      * @throws ConfigurationException if validation could not be turned on
      * @see Validator
      */
@@ -971,10 +982,10 @@ public class XMLAssertTestNG implements XSLTConstants {
      * Assert that a piece of XML contains valid XML: the document will be given a DOCTYPE to be validated with the name
      * and systemId specified regardless of whether it already contains a doctype declaration.
      * 
-     * @param xml
-     * @param systemId
-     * @param doctype
-     * @throws SAXException
+     * @param xml ...
+     * @param systemId ...
+     * @param doctype ...
+     * @throws SAXException ...
      * @throws ConfigurationException if validation could not be turned on
      * @see Validator
      */
@@ -987,10 +998,10 @@ public class XMLAssertTestNG implements XSLTConstants {
      * Assert that a String containing XML contains valid XML: the String will be given a DOCTYPE to be validated with
      * the name and systemId specified regardless of whether it already contains a doctype declaration.
      * 
-     * @param xmlString
-     * @param systemId
-     * @param doctype
-     * @throws SAXException
+     * @param xmlString ...
+     * @param systemId ...
+     * @param doctype ...
+     * @throws SAXException ...
      * @throws ConfigurationException if validation could not be turned on
      * @see Validator
      */
@@ -1002,22 +1013,22 @@ public class XMLAssertTestNG implements XSLTConstants {
     /**
      * Assert that a Validator instance returns <code>isValid() == true</code>
      * 
-     * @param validator
+     * @param validator ...
      */
     public static void assertXMLValid(Validator validator) {
         Assert.assertEquals(validator.isValid(), true, validator.toString());
     }
 
     /**
-     * Execute a <code>NodeTest<code> for a single node type
+     * Execute a <code>NodeTest</code> for a single node type
      * and assert that it passes
      * 
      * @param xml XML to be tested
      * @param tester The test strategy
      * @param nodeType The node type to be tested: constants defined in {@link org.w3c.dom.Node} e.g.
      *            <code>Node.ELEMENT_NODE</code>
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertNodeTestPasses(InputSource xml, NodeTester tester, short nodeType) throws SAXException,
             IOException {
@@ -1026,15 +1037,15 @@ public class XMLAssertTestNG implements XSLTConstants {
     }
 
     /**
-     * Execute a <code>NodeTest<code> for a single node type
+     * Execute a <code>NodeTest</code> for a single node type
      * and assert that it passes
      * 
      * @param xmlString XML to be tested
      * @param tester The test strategy
      * @param nodeType The node type to be tested: constants defined in {@link org.w3c.dom.Node} e.g.
      *            <code>Node.ELEMENT_NODE</code>
-     * @throws SAXException
-     * @throws IOException
+     * @throws SAXException ...
+     * @throws IOException ...
      */
     public static void assertNodeTestPasses(String xmlString, NodeTester tester, short nodeType) throws SAXException,
             IOException {
@@ -1043,7 +1054,7 @@ public class XMLAssertTestNG implements XSLTConstants {
     }
 
     /**
-     * Execute a <code>NodeTest<code> for multiple node types and make an
+     * Execute a <code>NodeTest</code> for multiple node types and make an
      * assertion about it whether it is expected to pass
      * 
      * @param test a NodeTest instance containing the XML source to be tested

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list