aboutsummaryrefslogtreecommitdiff
path: root/src/core/lombok/EqualsAndHashCode.java
diff options
context:
space:
mode:
authorReinier Zwitserloot <r.zwitserloot@projectlombok.org>2019-03-25 21:26:09 +0100
committerReinier Zwitserloot <r.zwitserloot@projectlombok.org>2019-03-25 21:26:09 +0100
commitec543dff8e91548b3533ab8510664fd26c898ae1 (patch)
treef0358c7f4fa98e6b7606b371803ee63c64de604e /src/core/lombok/EqualsAndHashCode.java
parent732d3db79a781b30e6763167ad1baf05ffb9f125 (diff)
downloadlombok-ec543dff8e91548b3533ab8510664fd26c898ae1.tar.gz
lombok-ec543dff8e91548b3533ab8510664fd26c898ae1.tar.bz2
lombok-ec543dff8e91548b3533ab8510664fd26c898ae1.zip
[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.
Diffstat (limited to 'src/core/lombok/EqualsAndHashCode.java')
-rw-r--r--src/core/lombok/EqualsAndHashCode.java9
1 files changed, 8 insertions, 1 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 "";
}
}