diff options
author | Reinier Zwitserloot <reinier@zwitserloot.com> | 2012-11-17 19:12:01 +0100 |
---|---|---|
committer | Reinier Zwitserloot <reinier@zwitserloot.com> | 2012-11-17 19:12:01 +0100 |
commit | 58851b4c6e96a51d1ac298c7ed85efac6ffe8335 (patch) | |
tree | b0ca24a4b8d5c04d70ada3bebb2308f3c74160b3 /src/core/lombok/Getter.java | |
parent | e95bb83e06510af7e68fc3eb38163522d6f75bce (diff) | |
download | lombok-58851b4c6e96a51d1ac298c7ed85efac6ffe8335.tar.gz lombok-58851b4c6e96a51d1ac298c7ed85efac6ffe8335.tar.bz2 lombok-58851b4c6e96a51d1ac298c7ed85efac6ffe8335.zip |
Updated the javadoc of each and every feature annotation that lombok has:
* Removed most documentation and instead put in a link to the much more up to date and extensive documentation at http://projectlombok.org/features
* Getting ahead of ourselves a little, added notes on onConstructor/onParam/onMethod which we are about to add in the next few commits.
* Updated copyrights to 2012.
Diffstat (limited to 'src/core/lombok/Getter.java')
-rw-r--r-- | src/core/lombok/Getter.java | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/src/core/lombok/Getter.java b/src/core/lombok/Getter.java index 3a92f67a..fa12ce1b 100644 --- a/src/core/lombok/Getter.java +++ b/src/core/lombok/Getter.java @@ -28,7 +28,11 @@ import java.lang.annotation.Target; /** * Put on any field to make lombok build a standard getter. - * + * <p> + * Complete documentation is found at <a href="http://projectlombok.org/features/GetterSetter.html">the project lombok features page for @Getter and @Setter</a>. + * <p> + * Even though it is not listed, this annotation also has the {@code onMethod} parameter. See the full documentation for more details. + * <p> * Example: * <pre> * private @Getter int foo; @@ -41,12 +45,6 @@ import java.lang.annotation.Target; * return this.foo; * } * </pre> - * - * Note that fields of type {@code boolean} (but not {@code java.lang.Boolean}) will result in an - * {@code isFoo} name instead of {@code getFoo}. - * <p> - * If any method named {@code getFoo}/{@code isFoo} (case insensitive) exists, regardless of return type or parameters, - * no method is generated, and instead a compiler warning is emitted. * <p> * This annotation can also be applied to a class, in which case it'll be as if all non-static fields that don't already have * a {@code @Getter} annotation have the annotation. |