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.

1 files changed, 3 insertions, 25 deletions

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)