From 2d3b98e847b9dc1878b657de97fce2f54104776d Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Fri, 16 Oct 2009 10:16:03 +0200 Subject: Switched all use of in javadoc to {@code}. --- src/lombok/javac/HandlerLibrary.java | 8 ++++---- src/lombok/javac/Javac.java | 6 +++--- src/lombok/javac/JavacAST.java | 2 +- src/lombok/javac/JavacAnnotationHandler.java | 8 ++++---- src/lombok/javac/handlers/HandleCleanup.java | 2 +- src/lombok/javac/handlers/HandleData.java | 2 +- src/lombok/javac/handlers/HandleEqualsAndHashCode.java | 2 +- src/lombok/javac/handlers/HandleGetter.java | 4 ++-- src/lombok/javac/handlers/HandlePrintAST.java | 2 +- src/lombok/javac/handlers/HandleSetter.java | 4 ++-- src/lombok/javac/handlers/HandleSneakyThrows.java | 2 +- src/lombok/javac/handlers/HandleSynchronized.java | 2 +- src/lombok/javac/handlers/HandleToString.java | 2 +- src/lombok/javac/handlers/PKG.java | 8 ++++---- 14 files changed, 27 insertions(+), 27 deletions(-) (limited to 'src/lombok/javac') diff --git a/src/lombok/javac/HandlerLibrary.java b/src/lombok/javac/HandlerLibrary.java index 3d44db7f..bbe9dec0 100644 --- a/src/lombok/javac/HandlerLibrary.java +++ b/src/lombok/javac/HandlerLibrary.java @@ -155,11 +155,11 @@ public class HandlerLibrary { * instance of {@link lombok.core.AnnotationValues}. * * Note that depending on the printASTOnly flag, the {@link lombok.core.PrintAST} annotation - * will either be silently skipped, or everything that isn't PrintAST will be skipped. + * will either be silently skipped, or everything that isn't {@code PrintAST} will be skipped. * * The HandlerLibrary will attempt to guess if the given annotation node represents a lombok annotation. - * For example, if lombok.* is in the import list, then this method will guess that - * Getter refers to lombok.Getter, presuming that {@link lombok.javac.handlers.HandleGetter} + * For example, if {@code lombok.*} is in the import list, then this method will guess that + * {@code Getter} refers to {@code lombok.Getter}, presuming that {@link lombok.javac.handlers.HandleGetter} * has been loaded. * * @param unit The Compilation Unit that contains the Annotation AST Node. @@ -203,7 +203,7 @@ public class HandlerLibrary { /** * Lombok does not currently support triggering annotations in a specified order; the order is essentially - * random right now. This lack of order is particularly annoying for the PrintAST annotation, + * random right now. This lack of order is particularly annoying for the {@code PrintAST} annotation, * which is almost always intended to run last. Hence, this hack, which lets it in fact run last. * * @see #skipAllButPrintAST() diff --git a/src/lombok/javac/Javac.java b/src/lombok/javac/Javac.java index 99a7c928..58a24207 100644 --- a/src/lombok/javac/Javac.java +++ b/src/lombok/javac/Javac.java @@ -56,7 +56,7 @@ public class Javac { /** * Checks if the Annotation AST Node provided is likely to be an instance of the provided annotation type. * - * @param type An actual annotation type, such as lombok.Getter.class. + * @param type An actual annotation type, such as {@code lombok.Getter.class}. * @param node A Lombok AST node representing an annotation in source code. */ public static boolean annotationTypeMatches(Class type, JavacNode node) { @@ -76,9 +76,9 @@ public class Javac { } /** - * Creates an instance of AnnotationValues for the provided AST Node. + * Creates an instance of {@code AnnotationValues} for the provided AST Node. * - * @param type An annotation class type, such as lombok.Getter.class. + * @param type An annotation class type, such as {@code lombok.Getter.class}. * @param node A Lombok AST node representing an annotation in source code. */ public static AnnotationValues createAnnotation(Class type, final JavacNode node) { diff --git a/src/lombok/javac/JavacAST.java b/src/lombok/javac/JavacAST.java index 2ee3d5be..eea1bad9 100644 --- a/src/lombok/javac/JavacAST.java +++ b/src/lombok/javac/JavacAST.java @@ -66,7 +66,7 @@ public class JavacAST extends AST { * Creates a new JavacAST of the provided Compilation Unit. * * @param trees The trees instance to use to inspect the compilation unit. Generate via: - * Trees.getInstance(env) + * {@code Trees.getInstance(env)} * @param env The ProcessingEnvironment object passed e.g. to an annotation processor. * @param top The compilation unit, which serves as the top level node in the tree to be built. */ diff --git a/src/lombok/javac/JavacAnnotationHandler.java b/src/lombok/javac/JavacAnnotationHandler.java index 84302a74..5b6fe4ce 100644 --- a/src/lombok/javac/JavacAnnotationHandler.java +++ b/src/lombok/javac/JavacAnnotationHandler.java @@ -32,11 +32,11 @@ import com.sun.tools.javac.tree.JCTree.JCAnnotation; * * You MUST replace 'T' with a specific annotation type, such as: * - * public class HandleGetter implements JavacAnnotationHandler<Getter> + * {@code public class HandleGetter implements JavacAnnotationHandler} * * 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 JavacAnnotationHandler. + * You also need to register yourself via SPI discovery as being an implementation of {@code JavacAnnotationHandler}. */ public interface JavacAnnotationHandler { /** @@ -51,8 +51,8 @@ public interface JavacAnnotationHandler { * @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 focused on the annotation. - * @return true if you don't want to be called again about this annotation during this - * compile session (you've handled it), or false to indicate you aren't done yet. + * @return {@code true} if you don't want to be called again about this annotation during this + * compile session (you've handled it), or {@code false} to indicate you aren't done yet. */ boolean handle(AnnotationValues annotation, JCAnnotation ast, JavacNode annotationNode); } diff --git a/src/lombok/javac/handlers/HandleCleanup.java b/src/lombok/javac/handlers/HandleCleanup.java index acee24b1..88a8e1d7 100644 --- a/src/lombok/javac/handlers/HandleCleanup.java +++ b/src/lombok/javac/handlers/HandleCleanup.java @@ -48,7 +48,7 @@ import com.sun.tools.javac.util.List; import com.sun.tools.javac.util.Name; /** - * Handles the lombok.Cleanup annotation for javac. + * Handles the {@code lombok.Cleanup} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandleCleanup implements JavacAnnotationHandler { diff --git a/src/lombok/javac/handlers/HandleData.java b/src/lombok/javac/handlers/HandleData.java index f18af241..8aa744c7 100644 --- a/src/lombok/javac/handlers/HandleData.java +++ b/src/lombok/javac/handlers/HandleData.java @@ -54,7 +54,7 @@ import com.sun.tools.javac.tree.JCTree.JCVariableDecl; import com.sun.tools.javac.util.List; /** - * Handles the lombok.Data annotation for javac. + * Handles the {@code lombok.Data} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandleData implements JavacAnnotationHandler { diff --git a/src/lombok/javac/handlers/HandleEqualsAndHashCode.java b/src/lombok/javac/handlers/HandleEqualsAndHashCode.java index fa1f4d0d..12eed02b 100644 --- a/src/lombok/javac/handlers/HandleEqualsAndHashCode.java +++ b/src/lombok/javac/handlers/HandleEqualsAndHashCode.java @@ -54,7 +54,7 @@ import com.sun.tools.javac.util.List; import com.sun.tools.javac.util.Name; /** - * Handles the lombok.EqualsAndHashCode annotation for javac. + * Handles the {@code lombok.EqualsAndHashCode} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandleEqualsAndHashCode implements JavacAnnotationHandler { diff --git a/src/lombok/javac/handlers/HandleGetter.java b/src/lombok/javac/handlers/HandleGetter.java index fd39bda2..49f732d8 100644 --- a/src/lombok/javac/handlers/HandleGetter.java +++ b/src/lombok/javac/handlers/HandleGetter.java @@ -47,7 +47,7 @@ import com.sun.tools.javac.util.Name; import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition; /** - * Handles the lombok.Getter annotation for javac. + * Handles the {@code lombok.Getter} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandleGetter implements JavacAnnotationHandler { @@ -58,7 +58,7 @@ public class HandleGetter implements JavacAnnotationHandler { * * The difference between this call and the handle method is as follows: * - * If there is a lombok.Getter annotation on the field, it is used and the + * If there is a {@code lombok.Getter} annotation on the field, it is used and the * same rules apply (e.g. warning if the method already exists, stated access level applies). * If not, the getter is still generated if it isn't already there, though there will not * be a warning if its already there. The default access level is used. diff --git a/src/lombok/javac/handlers/HandlePrintAST.java b/src/lombok/javac/handlers/HandlePrintAST.java index 77ecd54f..4c25694b 100644 --- a/src/lombok/javac/handlers/HandlePrintAST.java +++ b/src/lombok/javac/handlers/HandlePrintAST.java @@ -37,7 +37,7 @@ import lombok.javac.JavacAnnotationHandler; import lombok.javac.JavacNode; /** - * Handles the lombok.core.PrintAST annotation for javac. + * Handles the {@code lombok.core.PrintAST} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandlePrintAST implements JavacAnnotationHandler { diff --git a/src/lombok/javac/handlers/HandleSetter.java b/src/lombok/javac/handlers/HandleSetter.java index f7360988..08387895 100644 --- a/src/lombok/javac/handlers/HandleSetter.java +++ b/src/lombok/javac/handlers/HandleSetter.java @@ -49,7 +49,7 @@ import com.sun.tools.javac.util.Name; import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition; /** - * Handles the lombok.Setter annotation for javac. + * Handles the {@code lombok.Setter} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandleSetter implements JavacAnnotationHandler { @@ -60,7 +60,7 @@ public class HandleSetter implements JavacAnnotationHandler { * * The difference between this call and the handle method is as follows: * - * If there is a lombok.Setter annotation on the field, it is used and the + * If there is a {@code lombok.Setter} annotation on the field, it is used and the * same rules apply (e.g. warning if the method already exists, stated access level applies). * If not, the setter is still generated if it isn't already there, though there will not * be a warning if its already there. The default access level is used. diff --git a/src/lombok/javac/handlers/HandleSneakyThrows.java b/src/lombok/javac/handlers/HandleSneakyThrows.java index 3cbad7f6..a9cfc7a2 100644 --- a/src/lombok/javac/handlers/HandleSneakyThrows.java +++ b/src/lombok/javac/handlers/HandleSneakyThrows.java @@ -46,7 +46,7 @@ import com.sun.tools.javac.tree.JCTree.JCVariableDecl; import com.sun.tools.javac.util.List; /** - * Handles the lombok.SneakyThrows annotation for javac. + * Handles the {@code lombok.SneakyThrows} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandleSneakyThrows implements JavacAnnotationHandler { diff --git a/src/lombok/javac/handlers/HandleSynchronized.java b/src/lombok/javac/handlers/HandleSynchronized.java index 559c116a..4573deda 100644 --- a/src/lombok/javac/handlers/HandleSynchronized.java +++ b/src/lombok/javac/handlers/HandleSynchronized.java @@ -43,7 +43,7 @@ import lombok.javac.JavacAnnotationHandler; import lombok.javac.JavacNode; /** - * Handles the lombok.Synchronized annotation for javac. + * Handles the {@code lombok.Synchronized} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandleSynchronized implements JavacAnnotationHandler { diff --git a/src/lombok/javac/handlers/HandleToString.java b/src/lombok/javac/handlers/HandleToString.java index 4c9b9c89..d1c98525 100644 --- a/src/lombok/javac/handlers/HandleToString.java +++ b/src/lombok/javac/handlers/HandleToString.java @@ -50,7 +50,7 @@ import com.sun.tools.javac.tree.JCTree.JCVariableDecl; import com.sun.tools.javac.util.List; /** - * Handles the ToString annotation for javac. + * Handles the {@code ToString} annotation for javac. */ @ProviderFor(JavacAnnotationHandler.class) public class HandleToString implements JavacAnnotationHandler { diff --git a/src/lombok/javac/handlers/PKG.java b/src/lombok/javac/handlers/PKG.java index e2fceb08..d6fd1c61 100644 --- a/src/lombok/javac/handlers/PKG.java +++ b/src/lombok/javac/handlers/PKG.java @@ -169,7 +169,7 @@ class PKG { } /** - * Turns an AccessLevel instance into the flag bit used by javac. + * Turns an {@code AccessLevel} instance into the flag bit used by javac. * * @see java.lang.Modifier */ @@ -241,9 +241,9 @@ class PKG { } /** - * In javac, dotted access of any kind, from java.lang.String to var.methodName - * is represented by a fold-left of Select nodes with the leftmost string represented by - * a Ident node. This method generates such an expression. + * In javac, dotted access of any kind, from {@code java.lang.String} to {@code var.methodName} + * is represented by a fold-left of {@code Select} nodes with the leftmost string represented by + * a {@code Ident} node. This method generates such an expression. * * For example, maker.Select(maker.Select(maker.Ident(NAME[java]), NAME[lang]), NAME[String]). * -- cgit