Fixing JavaDocs for #91.

Author: highsource

runtime/pom.xml

@@ -30,7 +30,7 @@
 		<dependency>
 			<groupId>com.sun.activation</groupId>
 			<artifactId>javax.activation</artifactId>
-			<scope>test</scope>
+			<scope>provided</scope>
 		</dependency>
 		<dependency>
 			<groupId>junit</groupId>

runtime/src/main/java/org/jvnet/jaxb2_commons/lang/DefaultToStringStrategy.java

@@ -217,10 +217,14 @@ protected void appendNullText(StringBuilder buffer) {
 	 * Append to the <code>toString</code> the field start.
 	 * </p>
 	 * 
+	 * @param parentLocator
+	 *            locator of the parent object.
+	 * @param parent
+	 *            parent object.
+	 * @param fieldName
+	 *            name of the field.
 	 * @param buffer
 	 *            the <code>StringBuilder</code> to populate
-	 * @param propertyName
-	 *            the field name
 	 */
 	protected void appendFieldStart(ObjectLocator parentLocator, Object parent,
 			String fieldName, StringBuilder buffer) {
@@ -235,10 +239,16 @@ protected void appendFieldStart(ObjectLocator parentLocator, Object parent,
 	 * Append to the <code>toString</code> the field start.
 	 * </p>
 	 * 
+	 * @param parentLocator
+	 *            locator of the parent object.
+	 * @param parent
+	 *            parent object.
+	 * @param fieldName
+	 *            name of the field.
 	 * @param buffer
 	 *            the <code>StringBuilder</code> to populate
-	 * @param propertyName
-	 *            the field name
+	 * @param valueSet
+	 *            whether or not the field is set.
 	 */
 	protected void appendFieldStart(ObjectLocator parentLocator, Object parent,
 			String fieldName, StringBuilder buffer, boolean valueSet) {
@@ -250,13 +260,17 @@ protected void appendFieldStart(ObjectLocator parentLocator, Object parent,
 
 	/**
 	 * <p>
-	 * Append to the <code>toString<code> the field end.
+	 * Append to the <code>toString</code> the field end.
 	 * </p>
 	 * 
+	 * @param parentLocator
+	 *            locator of the parent object.
+	 * @param parent
+	 *            parent object.
+	 * @param fieldName
+	 *            name of the field.
 	 * @param buffer
 	 *            the <code>StringBuilder</code> to populate
-	 * @param propertyName
-	 *            the field name, typically not used as already appended
 	 */
 	protected void appendFieldEnd(ObjectLocator parentLocator, Object parent,
 			String fieldName, StringBuilder buffer) {
@@ -265,13 +279,19 @@ protected void appendFieldEnd(ObjectLocator parentLocator, Object parent,
 
 	/**
 	 * <p>
-	 * Append to the <code>toString<code> the field end.
+	 * Append to the <code>toString</code> the field end.
 	 * </p>
 	 * 
+	 * @param parentLocator
+	 *            locator of the parent object.
+	 * @param parent
+	 *            parent object.
+	 * @param fieldName
+	 *            name of the field.
 	 * @param buffer
 	 *            the <code>StringBuilder</code> to populate
-	 * @param propertyName
-	 *            the field name, typically not used as already appended
+	 * @param valueSet
+	 *            whether or not the field is set.
 	 */
 	protected void appendFieldEnd(ObjectLocator parentLocator, Object parent,
 			String fieldName, StringBuilder buffer, boolean valueSet) {
@@ -314,15 +334,15 @@ protected void appendDefaultFieldValueMarker(StringBuilder buffer) {
 	 * </p>
 	 * 
 	 * <p>
-	 * The default format is <code>'&lt;size=n&gt;'<code>.
+	 * The default format is <code>'&lt;size=n&gt;'</code>.
 	 * </p>
 	 * 
+	 * @param locator
+	 *            locator.
 	 * @param buffer
-	 *            the <code>StringBuilder</code> to populate
-	 * @param propertyName
-	 *            the field name, typically not used as already appended
+	 *            the <code>StringBuilder</code> to populate.
 	 * @param size
-	 *            the size to append
+	 *            the size to append.
 	 */
 	protected void appendSummarySize(ObjectLocator locator,
 			StringBuilder buffer, int size) {

runtime/src/main/java/org/jvnet/jaxb2_commons/locator/AbstractObjectLocator.java

@@ -29,8 +29,6 @@ public abstract class AbstractObjectLocator implements ObjectLocator {
 	 *            parent location (may be <code>null</code>).
 	 * @param object
 	 *            object.
-	 * @param propertyName
-	 *            field name.
 	 */
 	protected AbstractObjectLocator(final ObjectLocator parentLocator,
 			final Object object) {

runtime/src/main/java/org/jvnet/jaxb2_commons/locator/DefaultPropertyObjectLocator.java

@@ -19,11 +19,11 @@ public final class DefaultPropertyObjectLocator extends AbstractObjectLocator
 	 * Constructs a new validation event locator.
 	 * 
 	 * @param parentLocator
-	 *            parent location (may be <code>null</code>).
-	 * @param object
-	 *            object.
+	 *            locator of the parent object.
 	 * @param propertyName
-	 *            field name.
+	 *            name of the property.
+	 * @param propertyValue
+	 *            value of the property.
 	 */
 	protected DefaultPropertyObjectLocator(final ObjectLocator parentLocator,
 			final String propertyName, final Object propertyValue) {