Document how WeakOuter should be used on lambdas.
Change on 2017/01/03 by kstanger
@@ -24,8 +24,11 @@ import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
- * Annotation that indicates an inner class has a weak relationship
- * to its owning class.
+ * Annotation that indicates an inner class has a weak relationship to its owning class.
+ *
+ * Lambdas can be given a weak outer reference by declaring a local variable with this annotation
+ * and assigning the lambda expression directly to the local variable. WeakOuter is only allowed on
+ * local variables, not fields, to encourage the annotation to be used where the lambda is declared.
*
* @author Tom Ball
*/
