[JWebUnit-development] SF.net SVN: jwebunit:[956] trunk/jwebunit-core/src/main/java/net/ sourceforge/jwebunit/api/IElement.java

[<jev...@us...>]

Revision: 956
          http://jwebunit.svn.sourceforge.net/jwebunit/?rev=956&view=rev
Author:   jevonwright
Date:     2012-09-13 00:28:45 +0000 (Thu, 13 Sep 2012)
Log Message:
-----------
improving IElement Javadoc documentation

Modified Paths:
--------------
    trunk/jwebunit-core/src/main/java/net/sourceforge/jwebunit/api/IElement.java

Modified: trunk/jwebunit-core/src/main/java/net/sourceforge/jwebunit/api/IElement.java
===================================================================
--- trunk/jwebunit-core/src/main/java/net/sourceforge/jwebunit/api/IElement.java	2012-08-16 19:53:36 UTC (rev 955)
+++ trunk/jwebunit-core/src/main/java/net/sourceforge/jwebunit/api/IElement.java	2012-09-13 00:28:45 UTC (rev 956)
@@ -53,9 +53,9 @@
 	public String getTextContent();
 	
 	/**
-	 * Get the parent element, or null if none exists.
+	 * Get the parent element, or {@code null} if none exists.
 	 * 
-	 * @return The parent element or null
+	 * @return The parent element or {@code null}
 	 */
 	public IElement getParent();
 	
@@ -83,24 +83,28 @@
 	public List<IElement> getElements(String xpath);
 
 	/**
-	 * Set an attribute on this element.
+	 * Set an attribute on this element, e.g. "checked" for HTML4 &lt;select&gt;s.
 	 * 
-	 * @param string
+	 * @param string the attribute name
 	 */
 	public void setAttribute(String name);
 
 	/**
 	 * Set an attribute on this element.
 	 * 
-	 * @param string
-	 * @param value
+	 * @param string the attribute name
+	 * @param value the new attribute value
 	 */
 	public void setAttribute(String name, String value);
 
 	/**
 	 * Set the text content on this element.
+	 * Note that if you are trying to set the value of an &lt;input&gt; input, you should use
+	 * {@code setAttribute("value")} instead.
+	 * This also sets the text content of a &lt;textarea&gt; element.
 	 * 
-	 * @param value
+	 * @param value the new inner text content of this element
+	 * @see #setAttribute(String, String)
 	 */
 	public void setTextContent(String value);
 	

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.