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/Data.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/Data.java')
-rw-r--r-- | src/core/lombok/Data.java | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/src/core/lombok/Data.java b/src/core/lombok/Data.java index dda8b144..ee6f2fcb 100644 --- a/src/core/lombok/Data.java +++ b/src/core/lombok/Data.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2009 The Project Lombok Authors. + * Copyright (C) 2009-2012 The Project Lombok Authors. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -30,17 +30,16 @@ import java.lang.annotation.Target; * Generates getters for all fields, a useful toString method, and hashCode and equals implementations that check * all non-transient fields. Will also generate setters for all non-final fields, as well as a constructor. * <p> - * If any method to be generated already exists (in name and parameter count - the return type or parameter types are not relevant), then - * that method will not be generated by the Data annotation. + * Equivalent to {@code @Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode}. * <p> - * The generated constructor will have 1 parameter for each final field. The generated toString will print all fields, - * while the generated hashCode and equals take into account all non-transient fields.<br> - * Static fields are skipped (no getter or setter, and they are not included in toString, equals, hashCode, or the constructor). - * <p> - * {@code toString}, {@code equals}, and {@code hashCode} use the deepX variants in the - * {@code java.util.Arrays} utility class. Therefore, if your class has arrays that contain themselves, - * these methods will just loop endlessly until the inevitable {@code StackOverflowError}. This behaviour - * is no different from {@code java.util.ArrayList}, though. + * Complete documentation is found at <a href="http://projectlombok.org/features/Data.html">the project lombok features page for @Data</a>. + * + * @see Getter + * @see Setter + * @see RequiredArgsConstructor + * @see ToString + * @see EqualsAndHashCode + * @see lombok.experimental.Value */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.SOURCE) |