[Httpunit-commit] CVS: httpunit/src/com/meterware/httpunit Button.java,1.7,1.8 WebWindow.java,1.12,1.13 package.html,1.5,1.6

[Russell G. <rus...@us...>]

Update of /cvsroot/httpunit/httpunit/src/com/meterware/httpunit
In directory sc8-pr-cvs1:/tmp/cvs-serv23124/src/com/meterware/httpunit

Modified Files:
	Button.java WebWindow.java package.html 
Log Message:
Javadoc cleanup

Index: Button.java
===================================================================
RCS file: /cvsroot/httpunit/httpunit/src/com/meterware/httpunit/Button.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Button.java	13 Mar 2003 20:19:01 -0000	1.7
+++ Button.java	4 Apr 2003 14:20:11 -0000	1.8
@@ -28,6 +28,7 @@
 
 
 /**
+ * A button in a form.
  *
  * @author <a href="mailto:rus...@ht...">Russell Gold</a>
  **/

Index: WebWindow.java
===================================================================
RCS file: /cvsroot/httpunit/httpunit/src/com/meterware/httpunit/WebWindow.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- WebWindow.java	24 Mar 2003 15:04:33 -0000	1.12
+++ WebWindow.java	4 Apr 2003 14:20:12 -0000	1.13
@@ -27,8 +27,9 @@
 import org.xml.sax.SAXException;
 
 /**
+ * A window managed by a {@link com.meterware.httpunit.WebClient WebClient}.
  *
- * @author <a href="mailto:rus...@ac...">Russell Gold</a>
+ * @author <a href="mailto:rus...@ht...">Russell Gold</a>
  **/
 public class WebWindow {
 
@@ -47,6 +48,7 @@
     /** True if this window has been closed. **/
     private boolean _closed;
 
+
     /**
      * Returns the web client associated with this window.
      */
@@ -55,11 +57,17 @@
     }
 
 
+    /**
+     * Returns true if this window has been closed.
+     */
     public boolean isClosed() {
         return _closed;
     }
 
 
+    /**
+     * Closes this window.
+     */
     public void close() {
         if (!_closed) _client.close( this );
         _closed = true;

Index: package.html
===================================================================
RCS file: /cvsroot/httpunit/httpunit/src/com/meterware/httpunit/package.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- package.html	3 Nov 2002 17:37:37 -0000	1.5
+++ package.html	4 Apr 2003 14:20:12 -0000	1.6
@@ -15,13 +15,13 @@
 <dt>xmlParserAPIs.jar</dt><dd>The interfaces for a W3-compliant XML parser. Required for interpreting either HTML or XML pages.</dd>
 <dt>xercesImpl.jar</dt><dd>The <a href="http://xml.apache.org/xerces2-j/index.html">Xerces 2 implementation</a> of an XML parser.
 NekoHTML requires this implementation.
-<dt>servlet.jar</dt><dd>The APIs and common classes for the Java Servlet 1.3 standard. Required for use with <a href="../servletunit-intro.html">ServletUnit.</a></dd>
+<dt>servlet.jar</dt><dd>The APIs and common classes for the Java Servlet 1.3 standard. Required for use with <a href="../../../../servletunit-intro.html">ServletUnit.</a></dd>
 <dt>junit.jar</dt><dd><a href="http://www.junit.org">JUnit</a>, the unit test framework. Used to test HttpUnit and
 recommended for writing tests that use HttpUnit.</dd>
-</dl>
-No longer included, but still supported, is <A HREF="http://lempinen.net/sami/jtidy">JTidy</A>, an alternate HTML parser/validator.
+<dt>tidy.jar</dt><dd><A HREF="http://lempinen.net/sami/jtidy">JTidy</A>, an alternate HTML parser/validator.
 JTidy is a lot pickier about HTML structure than NekoHTML, and uses its own implementation of the DOM classes, rather than using those
-found in the xerces jar. Some JavaScript features, such as <code>document.write()</code> will only work with NekoHTML.
+found in the xerces jar. Some JavaScript features, such as <code>document.write()</code> will only work with NekoHTML.</dd>
+</dl>
 
 
 <H2>Example</H2>