aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorReinier Zwitserloot <reinier@zwitserloot.com>2012-11-17 19:12:01 +0100
committerReinier Zwitserloot <reinier@zwitserloot.com>2012-11-17 19:12:01 +0100
commit58851b4c6e96a51d1ac298c7ed85efac6ffe8335 (patch)
treeb0ca24a4b8d5c04d70ada3bebb2308f3c74160b3 /src
parente95bb83e06510af7e68fc3eb38163522d6f75bce (diff)
downloadlombok-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')
-rw-r--r--src/core/lombok/AllArgsConstructor.java10
-rw-r--r--src/core/lombok/Cleanup.java13
-rw-r--r--src/core/lombok/Data.java21
-rw-r--r--src/core/lombok/Delegate.java4
-rw-r--r--src/core/lombok/EqualsAndHashCode.java28
-rw-r--r--src/core/lombok/Getter.java12
-rw-r--r--src/core/lombok/NoArgsConstructor.java15
-rw-r--r--src/core/lombok/RequiredArgsConstructor.java8
-rw-r--r--src/core/lombok/Setter.java6
-rw-r--r--src/core/lombok/SneakyThrows.java33
-rw-r--r--src/core/lombok/Synchronized.java4
-rw-r--r--src/core/lombok/ToString.java25
-rw-r--r--src/core/lombok/experimental/Accessors.java3
-rw-r--r--src/core/lombok/experimental/ExtensionMethod.java3
-rw-r--r--src/core/lombok/experimental/FieldDefaults.java5
-rw-r--r--src/core/lombok/experimental/Value.java31
-rw-r--r--src/core/lombok/experimental/Wither.java7
-rw-r--r--src/core/lombok/extern/apachecommons/CommonsLog.java3
-rw-r--r--src/core/lombok/extern/java/Log.java3
-rw-r--r--src/core/lombok/extern/log4j/Log4j.java3
-rw-r--r--src/core/lombok/extern/slf4j/Slf4j.java3
-rw-r--r--src/core/lombok/extern/slf4j/XSlf4j.java3
-rw-r--r--src/core/lombok/val.java8
23 files changed, 112 insertions, 139 deletions
diff --git a/src/core/lombok/AllArgsConstructor.java b/src/core/lombok/AllArgsConstructor.java
index 7e55e4d1..2147bdae 100644
--- a/src/core/lombok/AllArgsConstructor.java
+++ b/src/core/lombok/AllArgsConstructor.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2010-2011 The Project Lombok Authors.
+ * Copyright (C) 2010-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
@@ -27,8 +27,12 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Generates an all-args constructor. An all-args constructor requires one argument
- * for every field in the class.
+ * Generates an all-args constructor.
+ * An all-args constructor requires one argument for every field in the class.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Constructor.html">the project lombok features page for &#64;Constructor</a>.
+ * <p>
+ * Even though it is not listed, this annotation also has the {@code onConstructor} parameter. See the full documentation for more details.
*
* @see NoArgsConstructor
* @see RequiredArgsConstructor
diff --git a/src/core/lombok/Cleanup.java b/src/core/lombok/Cleanup.java
index 7c849038..eb223958 100644
--- a/src/core/lombok/Cleanup.java
+++ b/src/core/lombok/Cleanup.java
@@ -31,6 +31,8 @@ import java.lang.annotation.Target;
* of what happens. Implemented by wrapping all statements following the local variable declaration to the
* end of your scope into a try block that, as a finally action, closes the resource.
* <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Cleanup.html">the project lombok features page for &#64;Cleanup</a>.
+ * <p>
* Example:
* <pre>
* public void copyFile(String in, String out) throws IOException {
@@ -59,20 +61,13 @@ import java.lang.annotation.Target;
* outStream.write(b, 0, r);
* }
* } finally {
- * out.close();
+ * if (out != null) out.close();
* }
* } finally {
- * in.close();
+ * if (in != null) in.close();
* }
* }
* </pre>
- *
- * Note that the final close method call, if it throws an exception, will overwrite any exception thrown
- * in the main body of the generated try block. You should NOT rely on this behaviour - future versions of
- * lombok intend to silently swallow any exception thrown by the cleanup method <i>_IF</i> the main body
- * throws an exception as well, as the earlier exception is usually far more useful.
- * <p>
- * However, in java 1.6, generating the code to do this is prohibitively complicated.
*/
@Target(ElementType.LOCAL_VARIABLE)
@Retention(RetentionPolicy.SOURCE)
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 &#64;Data</a>.
+ *
+ * @see Getter
+ * @see Setter
+ * @see RequiredArgsConstructor
+ * @see ToString
+ * @see EqualsAndHashCode
+ * @see lombok.experimental.Value
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
diff --git a/src/core/lombok/Delegate.java b/src/core/lombok/Delegate.java
index 9ab9acae..b599e4f0 100644
--- a/src/core/lombok/Delegate.java
+++ b/src/core/lombok/Delegate.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2010 The Project Lombok Authors.
+ * Copyright (C) 2010-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
@@ -39,6 +39,8 @@ import java.lang.annotation.Target;
* All public instance methods of the field's type, as well as all public instance methods of all the field's type's superfields are delegated, except for all methods
* that exist in {@link Object}, the {@code canEqual(Object)} method, and any methods that appear in types
* that are listed in the {@code excludes} property.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Delegate.html">the project lombok features page for &#64;Delegate</a>.
*/
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.SOURCE)
diff --git a/src/core/lombok/EqualsAndHashCode.java b/src/core/lombok/EqualsAndHashCode.java
index 120cc4d0..8b809c4b 100644
--- a/src/core/lombok/EqualsAndHashCode.java
+++ b/src/core/lombok/EqualsAndHashCode.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009-2010 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
@@ -27,31 +27,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Generates implementations for the {@code equals} and {@code hashCode} methods inherited by all objects.
+ * Generates implementations for the {@code equals} and {@code hashCode} methods inherited by all objects, based on relevant fields.
* <p>
- * If either method already exists, then {@code @EqualsAndHashCode} will not generate that particular method.
- * If they all exist, {@code @EqualsAndHashCode} generates no methods, and emits a warning instead to highlight
- * that its doing nothing at all. The parameter list and return type are not relevant when deciding to skip generation of
- * a method; any method named {@code hashCode} will make {@code @EqualsAndHashCode} not generate that method,
- * for example.
- * <p>
- * By default, all fields that are non-static and non-transient are used in the equality check and hashCode generation.
- * You can exclude more fields by specifying them in the {@code exclude} parameter. You can also explicitly specify
- * the fields that are to be used by specifying them in the {@code of} parameter.
- * <p>
- * Normally, auto-generating {@code hashCode} and {@code equals} implementations in a subclass is a bad idea, as
- * the superclass also defines fields, for which equality checks/hashcodes won't be auto-generated. Therefore, a warning
- * is emitted when you try. Instead, you can set the {@code callSuper} parameter to <em>true</em> which will call
- * {@code super.equals} and {@code super.hashCode}. Doing this with {@code java.lang.Object} as superclass is
- * pointless, so, conversely, setting this flag when <em>NOT</em> extending something (other than Object) will also generate
- * a warning. Be aware that not all implementations of {@code equals} correctly handle being called from a subclass!
- * Fortunately, lombok-generated {@code equals} implementations do correctly handle it.
- * <p>
- * Array fields are handled by way of {@link java.util.Arrays#deepEquals(Object[], Object[])} where necessary, as well
- * as {@code deepHashCode}. The downside is that arrays with circular references (arrays that contain themselves,
- * possibly indirectly) results in calls to {@code hashCode} and {@code equals} throwing a
- * {@link java.lang.StackOverflowError}. However, the implementations for java's own {@link java.util.ArrayList} suffer
- * from the same flaw.
+ * Complete documentation is found at <a href="http://projectlombok.org/features/EqualsAndHashCode.html">the project lombok features page for &#64;EqualsAndHashCode</a>.
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
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 &#64;Getter and &#64;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 &#64;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.
diff --git a/src/core/lombok/NoArgsConstructor.java b/src/core/lombok/NoArgsConstructor.java
index 985225f7..ba53e39f 100644
--- a/src/core/lombok/NoArgsConstructor.java
+++ b/src/core/lombok/NoArgsConstructor.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2010-2011 The Project Lombok Authors.
+ * Copyright (C) 2010-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
@@ -27,11 +27,14 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Generates a no-args constructor. Will generate an error message if such
- * a constructor cannot be written due to the existence of final fields.
- *
- * NB: Fields with constraints such as {@code @NonNull} will <em>NOT</em> be checked
- * in such a constructor, of course!
+ * Generates a no-args constructor.
+ * Will generate an error message if such a constructor cannot be written due to the existence of final fields.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Constructor.html">the project lombok features page for &#64;Constructor</a>.
+ * <p>
+ * Even though it is not listed, this annotation also has the {@code onConstructor} parameter. See the full documentation for more details.
+ * <p>
+ * NB: Fields with constraints such as {@code @NonNull} will <em>NOT</em> be checked in a {@code @NoArgsConstructor} constructor, of course!
*
* @see RequiredArgsConstructor
* @see AllArgsConstructor
diff --git a/src/core/lombok/RequiredArgsConstructor.java b/src/core/lombok/RequiredArgsConstructor.java
index da2d1e15..afe9773e 100644
--- a/src/core/lombok/RequiredArgsConstructor.java
+++ b/src/core/lombok/RequiredArgsConstructor.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2010-2011 The Project Lombok Authors.
+ * Copyright (C) 2010-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
@@ -29,7 +29,11 @@ import java.lang.annotation.Target;
/**
* Generates a constructor with required arguments.
* Required arguments are final fields and fields with constraints such as {@code @NonNull}.
- *
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Constructor.html">the project lombok features page for &#64;Constructor</a>.
+ * <p>
+ * Even though it is not listed, this annotation also has the {@code onConstructor} parameter. See the full documentation for more details.
+ *
* @see NoArgsConstructor
* @see AllArgsConstructor
*/
diff --git a/src/core/lombok/Setter.java b/src/core/lombok/Setter.java
index a7318259..59ed9346 100644
--- a/src/core/lombok/Setter.java
+++ b/src/core/lombok/Setter.java
@@ -29,6 +29,10 @@ import java.lang.annotation.Target;
/**
* Put on any field to make lombok build a standard setter.
* <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/GetterSetter.html">the project lombok features page for &#64;Getter and &#64;Setter</a>.
+ * <p>
+ * Even though it is not listed, this annotation also has the {@code onParam} and {@code onMethod} parameter. See the full documentation for more details.
+ * <p>
* Example:
* <pre>
* private &#64;Setter int foo;
@@ -42,8 +46,6 @@ import java.lang.annotation.Target;
* }
* </pre>
*
- * If any method named {@code setFoo} (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 Setter} annotation have the annotation.
diff --git a/src/core/lombok/SneakyThrows.java b/src/core/lombok/SneakyThrows.java
index d1ffa5b6..4bd79065 100644
--- a/src/core/lombok/SneakyThrows.java
+++ b/src/core/lombok/SneakyThrows.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
@@ -34,21 +34,7 @@ import java.lang.annotation.Target;
* checked exception types. The JVM does not check for the consistency of the checked exception system; javac does,
* and this annotation lets you opt out of its mechanism.
* <p>
- * You should use this annotation ONLY in the following two cases:<ol>
- * <li>You are certain the listed exception can't actually ever happen, or only in vanishingly rare situations.
- * You don't try to catch OutOfMemoryError on every statement either. Examples:<br>
- * {@code IOException} in {@code ByteArrayOutputStream}<br>
- * {@code UnsupportedEncodingException} in new String(byteArray, "UTF-8").</li>
- * <li>You know for certain the caller can handle the exception (for example, because the caller is
- * an app manager that will handle all throwables that fall out of your method the same way), but due
- * to interface restrictions you can't just add these exceptions to your 'throws' clause.
- * <p>
- * Note that, as SneakyThrow is an implementation detail and <i>NOT</i> part of your method signature, it is
- * a compile time error if none of the statements in your method body can throw a listed exception.
- * <p>
- * <b><i>WARNING: </b></i>You must have lombok.jar available at the runtime of your app if you use SneakyThrows,
- * because your code is rewritten to use {@link Lombok#sneakyThrow(Throwable)}.
- * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/SneakyThrows.html">the project lombok features page for &#64;SneakyThrows</a>.
* <p>
* Example:
* <pre>
@@ -58,10 +44,17 @@ import java.lang.annotation.Target;
* }
* </pre>
*
- * {@code @SneakyThrows} without a parameter defaults to allowing <i>every</i> checked exception.
- * (The default is {@code Throwable.class}).
- *
- * @see Lombok#sneakyThrow(Throwable)
+ * Becomes:
+ * <pre>
+ * public void utf8ToString(byte[] bytes) {
+ * try {
+ * return new String(bytes, "UTF-8");
+ * } catch (UnsupportedEncodingException $uniqueName) {
+ * throw useMagicTrickeryToHideThisFromTheCompiler($uniqueName);
+ * // This trickery involves a bytecode transformer run automatically during the final stages of compilation;
+ * // there is no runtime dependency on lombok.
+ * }
+ * </pre>
*/
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.SOURCE)
diff --git a/src/core/lombok/Synchronized.java b/src/core/lombok/Synchronized.java
index dbccbbf9..fadea89a 100644
--- a/src/core/lombok/Synchronized.java
+++ b/src/core/lombok/Synchronized.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009-2011 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
@@ -34,6 +34,8 @@ import java.lang.annotation.Target;
* For non-static methods, a field named {@code $lock} is used, and for static methods,
* {@code $LOCK} is used. These will be generated if needed and if they aren't already present. The contents
* of the fields will be serializable.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Synchronized.html">the project lombok features page for &#64;Synchronized</a>.
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
diff --git a/src/core/lombok/ToString.java b/src/core/lombok/ToString.java
index 326dcdab..e39b9858 100644
--- a/src/core/lombok/ToString.java
+++ b/src/core/lombok/ToString.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009-2010 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
@@ -27,28 +27,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Generates an implementation for the {@code toString} method inherited by all objects.
+ * Generates an implementation for the {@code toString} method inherited by all objects, consisting of printing the values of relevant fields.
* <p>
- * If the method already exists, then {@code ToString} will not generate any method, and instead warns
- * that it's doing nothing at all. The parameter list and return type are not relevant when deciding to skip generation of
- * the method; any method named {@code toString} will make {@code ToString} not generate anything.
- * <p>
- * By default, all fields that are non-static are used in the toString generation. You can exclude fields by specifying them
- * in the {@code exclude} parameter. You can also explicitly specify the fields that
- * are to be used by specifying them in the {@code of} parameter.
- * <p>
- * Array fields are handled by way of {@link java.util.Arrays#deepToString(Object[])} where necessary.
- * The downside is that arrays with circular references (arrays that contain themselves,
- * possibly indirectly) results in calls to {@code toString} throwing a
- * {@link java.lang.StackOverflowError}. However, the implementations for java's own {@link java.util.ArrayList} suffer
- * from the same flaw.
- * <p>
- * The {@code toString} method that is generated will print the class name as well as each field (both the name
- * and the value). You can optionally choose to suppress the printing of the field name, by setting the
- * {@code includeFieldNames} flag to <em>false</em>.
- * <p>
- * You can also choose to include the result of {@code toString} in your class's superclass by setting the
- * {@code callSuper} to <em>true</em>.
+ * Complete documentation is found at <a href="http://projectlombok.org/features/ToString.html">the project lombok features page for &#64;ToString</a>.
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
diff --git a/src/core/lombok/experimental/Accessors.java b/src/core/lombok/experimental/Accessors.java
index b925e746..2748bfa9 100644
--- a/src/core/lombok/experimental/Accessors.java
+++ b/src/core/lombok/experimental/Accessors.java
@@ -28,6 +28,9 @@ import java.lang.annotation.Target;
/**
* A container for settings for the generation of getters and setters.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/experimental/Accessors.html">the project lombok features page for &#64;Accessors</a>.
+ * <p>
* Using this annotation does nothing by itself; an annotation that makes lombok generate getters and setters,
* such as {@link lombok.Setter} or {@link lombok.Data} is also required.
*/
diff --git a/src/core/lombok/experimental/ExtensionMethod.java b/src/core/lombok/experimental/ExtensionMethod.java
index 74787fac..44f28d04 100644
--- a/src/core/lombok/experimental/ExtensionMethod.java
+++ b/src/core/lombok/experimental/ExtensionMethod.java
@@ -31,6 +31,9 @@ import java.lang.annotation.*;
* otherwise modifying the original type. Extension methods are a special kind of static method, but they are called as
* if they were instance methods on the extended type.
* <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/experimental/ExtensionMethod.html">the project lombok features page for &#64;ExtensionMethod</a>.
+ * <p>
+ * <p>
* Before:
*
* <pre>
diff --git a/src/core/lombok/experimental/FieldDefaults.java b/src/core/lombok/experimental/FieldDefaults.java
index 5bbf92dc..8a3fb534 100644
--- a/src/core/lombok/experimental/FieldDefaults.java
+++ b/src/core/lombok/experimental/FieldDefaults.java
@@ -30,12 +30,13 @@ import lombok.AccessLevel;
/**
* Adds modifiers to each field in the type with this annotation.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/experimental/FieldDefaults.html">the project lombok features page for &#64;FieldDefaults</a>.
+ * <p>
* If {@code makeFinal} is {@code true}, then each field that is not annotated with {@code @NonFinal} will have the {@code final} modifier added.
* <p>
* If {@code level} is set, then each field that is package private (i.e. no access modifier) and does not have the {@code @PackagePrivate} annotation will
* have the appropriate access level modifier added.
- * <p>
- * The only fields that are skipped are those that start with a '$'; everything else, including static, volatile, and transient fields, are modified.
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
diff --git a/src/core/lombok/experimental/Value.java b/src/core/lombok/experimental/Value.java
index 70ac1ba7..6c07d2fc 100644
--- a/src/core/lombok/experimental/Value.java
+++ b/src/core/lombok/experimental/Value.java
@@ -28,30 +28,17 @@ import java.lang.annotation.Target;
/**
* Generates a lot of code which fits with a class that is a representation of an immutable entity.
- * Specifically, it generates:<ul>
- * <li>Getters for all fields
- * <li>toString method
- * <li>hashCode and equals implementations that check all non-transient fields.
- * <li>Generates withers for all fields (except final fields that are initialized in the field declaration itself)
- * <li>Generates a constructor for each argument
- * <li>Adds {@code private} and {@code final} to each field.
- * <li>Makes the class itself final.
- * </ul>
- *
- * In other words, {@code @Value} is a shorthand for:<br />
- * {@code final @Getter @Wither @FieldDefaults(makeFinal=true,level=AccessLevel.PRIVATE) @EqualsAndHashCode @ToString @AllArgsConstructor}.
- * <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 Value annotation.
* <p>
- * The generated constructor will have 1 parameter for each 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).
+ * Equivalent to {@code @Getter @Wither @FieldDefaults(makeFinal=true, level=AccessLevel.PRIVATE) @RequiredArgsConstructor @ToString @EqualsAndHashCode}.
* <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/experimental/Value.html">the project lombok features page for &#64;Value</a>.
+ *
+ * @see lombok.Getter
+ * @see Wither
+ * @see lombok.RequiredArgsConstructor
+ * @see lombok.ToString
+ * @see lombok.EqualsAndHashCode
+ * @see lombok.Data
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
diff --git a/src/core/lombok/experimental/Wither.java b/src/core/lombok/experimental/Wither.java
index ec2f5496..58be660a 100644
--- a/src/core/lombok/experimental/Wither.java
+++ b/src/core/lombok/experimental/Wither.java
@@ -31,6 +31,10 @@ import lombok.AccessLevel;
/**
* Put on any field to make lombok build a 'wither' - a withX method which produces a clone of this object (except for 1 field which gets a new value).
* <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/experimental/Wither.html">the project lombok features page for &#64;Wither</a>.
+ * <p>
+ * Even though it is not listed, this annotation also has the {@code onParam} and {@code onMethod} parameter. See the full documentation for more details.
+ * <p>
* Example:
* <pre>
* private &#64;Wither final int foo;
@@ -43,9 +47,6 @@ import lombok.AccessLevel;
* return this.foo == foo ? this : new SELF_TYPE(otherField1, otherField2, foo);
* }
* </pre>
- *
- * If any method named {@code withFoo} (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 Wither} annotation have the annotation.
diff --git a/src/core/lombok/extern/apachecommons/CommonsLog.java b/src/core/lombok/extern/apachecommons/CommonsLog.java
index 3fb178c7..f178ae05 100644
--- a/src/core/lombok/extern/apachecommons/CommonsLog.java
+++ b/src/core/lombok/extern/apachecommons/CommonsLog.java
@@ -28,6 +28,9 @@ import java.lang.annotation.Target;
/**
* Causes lombok to generate a logger field.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Log.html">the project lombok features page for lombok log annotations</a>.
+ * <p>
* Example:
* <pre>
* &#64;CommonsLog
diff --git a/src/core/lombok/extern/java/Log.java b/src/core/lombok/extern/java/Log.java
index dba83c60..90c62956 100644
--- a/src/core/lombok/extern/java/Log.java
+++ b/src/core/lombok/extern/java/Log.java
@@ -28,6 +28,9 @@ import java.lang.annotation.Target;
/**
* Causes lombok to generate a logger field.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Log.html">the project lombok features page for lombok log annotations</a>.
+ * <p>
* Example:
* <pre>
* &#64;Log
diff --git a/src/core/lombok/extern/log4j/Log4j.java b/src/core/lombok/extern/log4j/Log4j.java
index 3de291b6..9cfc5839 100644
--- a/src/core/lombok/extern/log4j/Log4j.java
+++ b/src/core/lombok/extern/log4j/Log4j.java
@@ -28,6 +28,9 @@ import java.lang.annotation.Target;
/**
* Causes lombok to generate a logger field.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Log.html">the project lombok features page for lombok log annotations</a>.
+ * <p>
* Example:
* <pre>
* &#64;Log4j
diff --git a/src/core/lombok/extern/slf4j/Slf4j.java b/src/core/lombok/extern/slf4j/Slf4j.java
index fababb83..14dbcba6 100644
--- a/src/core/lombok/extern/slf4j/Slf4j.java
+++ b/src/core/lombok/extern/slf4j/Slf4j.java
@@ -27,6 +27,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Causes lombok to generate a logger field.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Log.html">the project lombok features page for lombok log annotations</a>.
+ * <p>
* Example:
* <pre>
* &#64;Slf4j
diff --git a/src/core/lombok/extern/slf4j/XSlf4j.java b/src/core/lombok/extern/slf4j/XSlf4j.java
index 73fbd74c..bdf8a62c 100644
--- a/src/core/lombok/extern/slf4j/XSlf4j.java
+++ b/src/core/lombok/extern/slf4j/XSlf4j.java
@@ -27,6 +27,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Causes lombok to generate a logger field.
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/Log.html">the project lombok features page for lombok log annotations</a>.
+ * <p>
* Example:
* <pre>
* &#64;XSlf4j
diff --git a/src/core/lombok/val.java b/src/core/lombok/val.java
index e2a56f1c..7e495c8d 100644
--- a/src/core/lombok/val.java
+++ b/src/core/lombok/val.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2010 The Project Lombok Authors.
+ * Copyright (C) 2010-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
@@ -25,7 +25,9 @@ package lombok;
* Use {@code val} as the type of any local variable declaration (even in a for-each statement), and the type will be inferred from the initializing expression.
* For example: {@code val x = 10.0;} will infer {@code double}, and {@code val y = new ArrayList<String>();} will infer {@code ArrayList<String>}. The local variable
* will also be made final.
- *
- * Note that this is an interface because {@code val x = 10;} will be desugared to {@code &#64;val int x = 10;}
+ * <p>
+ * Note that this is an annotation type because {@code val x = 10;} will be desugared to {@code @val final int x = 10;}
+ * <p>
+ * Complete documentation is found at <a href="http://projectlombok.org/features/val.html">the project lombok features page for &#64;val</a>.
*/
public @interface val {}