From 527b992a074c1c65727bc52c820d40340f074a6b Mon Sep 17 00:00:00 2001
From: Reinier Zwitserloot <reinier@tipit.to>
Date: Mon, 6 Jul 2009 05:48:42 +0200
Subject: Last massive documentation dump. All basic javadoc is now done,
 though especially the docs on the lombok annotations in the lombok package
 need far more massaging.

Also added a feature to HandleSynchronized to not auto-generate the locker fields if
a specific name is provided (because, imagine you typoed those. You'd never find it!)
---
 src/lombok/Getter.java | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

(limited to 'src/lombok/Getter.java')

diff --git a/src/lombok/Getter.java b/src/lombok/Getter.java
index d59ea672..581a252d 100644
--- a/src/lombok/Getter.java
+++ b/src/lombok/Getter.java
@@ -1,3 +1,24 @@
+/*
+ * Copyright © 2009 Reinier Zwitserloot and Roel Spilker.
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
 package lombok;
 
 import java.lang.annotation.ElementType;
@@ -5,8 +26,33 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Put on any field to make lombok build a standard getter.
+ * 
+ * Example:
+ * <pre>
+ *     private @Getter int foo;
+ * </pre>
+ * 
+ * will generate:
+ * 
+ * <pre>
+ *     public int getFoo() {
+ *         return this.foo;
+ *     }
+ * </pre>
+ * 
+ * Note that fields of type <code>boolean</code> (but not <code>java.lang.Boolean</code>) will result in an
+ * <code>isFoo</code> name instead of <code>getFoo</code>.
+ * 
+ * If any method named <code>getFoo</code>/<code>isFoo</code> exists, regardless of return type or parameters, no method is generated,
+ * and instead a compiler warning is emitted.
+ */
 @Target(ElementType.FIELD)
 @Retention(RetentionPolicy.SOURCE)
 public @interface Getter {
+	/**
+	 * If you want your setter to be non-public, you can specify an alternate access level here.
+	 */
 	lombok.AccessLevel value() default lombok.AccessLevel.PUBLIC;
 }
-- 
cgit