More documentation.

1 files changed, 47 insertions, 0 deletions

diff --git a/src/lombok/javac/JavacAnnotationHandler.java b/src/lombok/javac/JavacAnnotationHandler.java
index 58308de1..65832eab 100644
--- a/src/lombok/javac/JavacAnnotationHandler.java
+++ b/src/lombok/javac/JavacAnnotationHandler.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.javac;
 
 import java.lang.annotation.Annotation;
@@ -6,6 +27,32 @@ import lombok.core.AnnotationValues;
 
 import com.sun.tools.javac.tree.JCTree.JCAnnotation;
 
+/**
+ * Implement this interface if you want to be triggered for a specific annotation.
+ * 
+ * You MUST replace 'T' with a specific annotation type, such as:
+ * 
+ * <code>public class HandleGetter implements JavacAnnotationHandler&lt;<b>Getter</b>&gt;</code>
+ * 
+ * Because this generics parameter is inspected to figure out which class you're interested in.
+ * 
+ * You also need to register yourself via SPI discovery as being an implementation of <code>JavacAnnotationHandler</code>.
+ */
 public interface JavacAnnotationHandler<T extends Annotation> {
+	/**
+	 * Called when an annotation is found that is likely to match the annotation you're interested in.
+	 * 
+	 * Be aware that you'll be called for ANY annotation node in the source that looks like a match. There is,
+	 * for example, no guarantee that the annotation node belongs to a method, even if you set your
+	 * TargetType in the annotation to methods only.
+	 * 
+	 * @param annotation The actual annotation - use this object to retrieve the annotation parameters.
+	 * @param ast The javac AST node representing the annotation.
+	 * @param annotationNode The Lombok AST wrapper around the 'ast' parameter. You can use this object
+	 * to travel back up the chain (something javac AST can't do) to the parent of the annotation, as well
+	 * as access useful methods such as generating warnings or errors focussed on the annotation.
+	 * @return <code>true</code> if you don't want to be called again about this annotation during this
+	 * compile session (you've handled it), or <code>false</code> to indicate you aren't done yet.
+	 */
 	boolean handle(AnnotationValues<T> annotation, JCAnnotation ast, JavacAST.Node annotationNode);
 }