aboutsummaryrefslogtreecommitdiff
path: root/src/core/lombok/Getter.java
diff options
context:
space:
mode:
authorReinier Zwitserloot <reinier@zwitserloot.com>2017-06-12 23:39:36 +0200
committerReinier Zwitserloot <reinier@zwitserloot.com>2017-06-13 00:15:32 +0200
commit5edb6ce5e10d40572a6a760902a415264c9a485e (patch)
treebbcc72273795b3c68d2784eaedbfdf74f56c679f /src/core/lombok/Getter.java
parente0a91d25896b9d67f0cf3f1a5bb94c40e1ecfc94 (diff)
downloadlombok-5edb6ce5e10d40572a6a760902a415264c9a485e.tar.gz
lombok-5edb6ce5e10d40572a6a760902a415264c9a485e.tar.bz2
lombok-5edb6ce5e10d40572a6a760902a415264c9a485e.zip
Javadoc now builds without warnings. All links to external javadoc replaced with straight up links to avoid the <javadoc> target from trying to download a bunch of index pages.
Diffstat (limited to 'src/core/lombok/Getter.java')
-rw-r--r--src/core/lombok/Getter.java18
1 files changed, 11 insertions, 7 deletions
diff --git a/src/core/lombok/Getter.java b/src/core/lombok/Getter.java
index f410eba7..5a23fe30 100644
--- a/src/core/lombok/Getter.java
+++ b/src/core/lombok/Getter.java
@@ -54,25 +54,29 @@ import java.lang.annotation.Target;
public @interface Getter {
/**
* If you want your getter to be non-public, you can specify an alternate access level here.
+ *
+ * @return The getter method will be generated with this access modifier.
*/
lombok.AccessLevel value() default lombok.AccessLevel.PUBLIC;
/**
* Any annotations listed here are put on the generated method.
- * The syntax for this feature depends on JDK version (nothing we can do about that; it's to work around javac bugs).<br />
- * up to JDK7:<br />
- * {@code @Getter(onMethod=@__({@AnnotationsGoHere}))}<br />
- * from JDK8:<br />
+ * The syntax for this feature depends on JDK version (nothing we can do about that; it's to work around javac bugs).<br>
+ * up to JDK7:<br>
+ * {@code @Getter(onMethod=@__({@AnnotationsGoHere}))}<br>
+ * from JDK8:<br>
* {@code @Getter(onMethod_={@AnnotationsGohere})} // note the underscore after {@code onMethod}.
+ *
+ * @return List of annotations to apply to the generated getter method.
*/
AnyAnnotation[] onMethod() default {};
boolean lazy() default false;
/**
- * Placeholder annotation to enable the placement of annotations on the generated code.
- * @deprecated Don't use this annotation, ever - Read the documentation.
- */
+ * Placeholder annotation to enable the placement of annotations on the generated code.
+ * @deprecated Don't use this annotation, ever - Read the documentation.
+ */
@Deprecated
@Retention(RetentionPolicy.SOURCE)
@Target({})