From cb091204f4bfc7f9971fc296903f7bc2a163f085 Mon Sep 17 00:00:00 2001
From: Reinier Zwitserloot <reinier@tipit.to>
Date: Tue, 1 Sep 2009 00:19:28 +0200
Subject: Fixed documentation, specifically: added eclipse help system fix to
 the changelog, and added some documentation on the special handling of
 @NonNull/@NotNull/@Nullable for Data and Getter/Setter on the website docs.

---
 website/features/Data.html | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'website/features/Data.html')

diff --git a/website/features/Data.html b/website/features/Data.html
index 19eacdd8..9216d46e 100644
--- a/website/features/Data.html
+++ b/website/features/Data.html
@@ -22,7 +22,8 @@
 			together: In other words, <code>@Data</code> generates <em>all</em> the boilerplate that is normally associated with simple POJOs
 			(Plain Old Java Objects) and beans: getters for all fields, setters for all non-final fields, and appropriate <code>toString</code>, <code>equals</code>
 			and <code>hashCode</code> implementations that involve the fields of the class. In addition, <code>@Data</code> generates a constructor that
-			initialized all final fields.
+			initializes all final fields, as well as all non-final fields with no initializer that have been marked with <code>@NonNull</code> or <code>@NotNull</code>,
+			in order to ensure the field is never null.
 			</p><p>
 			<code>@Data</code> is like having implicit <code>@ToString</code> and <code>@EqualsAndHashCode</code> annotations on the class.
 			However, the parameters of <code>@ToString</code> and <code>@EqualsAndHashCode</code> (such as <code>callSuper</code>, <code>includeFieldNames</code> and
@@ -62,6 +63,12 @@
 			<h3>Small print</h3><div class="smallprint">
 				<p>See the small print of <a href="ToString.html"><code>@ToString</code></a>, <a href="EqualsAndHashCode.html"><code>@EqualsAndHashCode</code></a> and
 					<a href="GetterSetter.html"><code>@Getter / @Setter</code></a>.
+				</p><p>
+					Any annotations named <code>@NonNull</code> or <code>@NotNull</code> (case insensitive) on a field are interpreted as: This field must not ever hold
+					<em>null</em>. Therefore, these annotations result in an explicit null check in the generated constructor for the provided field. Also, these
+					annotations (as well as any annotation named <code>@Nullable</code>) are copied to the constructor parameter, in both the true constructor and
+					any static constructor. The same principle applies to generated getters and setters (see the documentation for <a href="GetterSetter.html">@Getter / @Setter</a>)
+				</p>
 			</div>
 		</div>
 		<div class="footer">
-- 
cgit