[javadoc] new javadoc tools, new boneheaded mistakes. Seemingly nobody gives a toss about this tool over at oracle? Used some hacks to work around the worst offenses.

3 files changed, 23 insertions, 3 deletions

diff --git a/src/core/lombok/EqualsAndHashCode.java b/src/core/lombok/EqualsAndHashCode.java
index b2fc672d..e752165c 100644
--- a/src/core/lombok/EqualsAndHashCode.java
+++ b/src/core/lombok/EqualsAndHashCode.java
@@ -97,6 +97,8 @@ public @interface EqualsAndHashCode {
 	/**
 	 * Only include fields and methods explicitly marked with {@code @EqualsAndHashCode.Include}.
 	 * Normally, all (non-static, non-transient) fields are included by default.
+	 * 
+	 * @return If {@code true}, don't include non-static non-transient fields automatically (default: {@code false}).
 	 */
 	boolean onlyExplicitlyIncluded() default false;
 	
@@ -113,7 +115,12 @@ public @interface EqualsAndHashCode {
 	@Target({ElementType.FIELD, ElementType.METHOD})
 	@Retention(RetentionPolicy.SOURCE)
 	public @interface Include {
-		/** Defaults to the method name of the annotated member. If on a method and the name equals the name of a default-included field, this member takes its place. */
+		/**
+		 * Defaults to the method name of the annotated member.
+		 * If on a method and the name equals the name of a default-included field, this member takes its place.
+		 * 
+		 * @return If present, this method serves as replacement for the named field.
+		 */
 		String replaces() default "";
 	}
 }
diff --git a/src/core/lombok/ToString.java b/src/core/lombok/ToString.java
index ae3f071f..34418a2f 100644
--- a/src/core/lombok/ToString.java
+++ b/src/core/lombok/ToString.java
@@ -83,6 +83,8 @@ public @interface ToString {
 	/**
 	 * Only include fields and methods explicitly marked with {@code @ToString.Include}.
 	 * Normally, all (non-static) fields are included by default.
+	 * 
+	 * @return If {@code true}, don't include non-static fields automatically (default: {@code false}).
 	 */
 	boolean onlyExplicitlyIncluded() default false;
 	
@@ -102,10 +104,19 @@ public @interface ToString {
 //		/** If true and the return value is {@code null}, omit this member entirely from the {@code toString} output. */
 //		boolean skipNull() default false; // -- We'll add it later, it requires a complete rework on the toString code we generate.
 		
-		/** Higher ranks are printed first. Members of the same rank are printed in the order they appear in the source file. */
+		/**
+		 * Higher ranks are printed first. Members of the same rank are printed in the order they appear in the source file.
+		 * 
+		 * @return ordering within the generating {@code toString()}; higher numbers are printed first.
+		 */
 		int rank() default 0;
 		
-		/** Defaults to the field / method name of the annotated member. If the name equals the name of a default-included field, this member takes its place. */
+		/**
+		 * Defaults to the field / method name of the annotated member.
+		 * If the name equals the name of a default-included field, this member takes its place.
+		 * 
+		 * @return The name to show in the generated {@code toString()}. Also, if this annotation is on a method and the name matches an existing field, it replaces that field.
+		 */
 		String name() default "";
 	}
 }
diff --git a/src/core/lombok/experimental/FieldNameConstants.java b/src/core/lombok/experimental/FieldNameConstants.java
index d6886890..da97a721 100644
--- a/src/core/lombok/experimental/FieldNameConstants.java
+++ b/src/core/lombok/experimental/FieldNameConstants.java
@@ -41,6 +41,8 @@ public @interface FieldNameConstants {
 	/**
 	 * Only include fields and methods explicitly marked with {@code @FieldNameConstants.Include}.
 	 * Normally, all (non-static) fields are included by default.
+	 * 
+	 * @return If {@code true}, don't include non-static fields automatically (default: {@code false}).
 	 */
 	boolean onlyExplicitlyIncluded() default false;