From 8534a8e0a552f21ad6479e94fad8db36e67d44d5 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Mon, 6 Jul 2009 06:08:05 +0200 Subject: Fixed javadoc problems, and added a javadoc target to the build script. --- src/lombok/Cleanup.java | 12 ++++++------ src/lombok/Data.java | 4 ++-- src/lombok/Getter.java | 2 +- src/lombok/Lombok.java | 8 ++++---- src/lombok/Setter.java | 2 +- src/lombok/SneakyThrows.java | 22 +++++++++++----------- src/lombok/Synchronized.java | 2 +- src/lombok/core/AST.java | 4 ++-- src/lombok/core/AnnotationValues.java | 4 ++-- src/lombok/eclipse/EclipseAST.java | 2 +- src/lombok/eclipse/EclipseASTVisitor.java | 2 +- src/lombok/eclipse/HandlerLibrary.java | 10 +++++----- src/lombok/installer/Installer.java | 2 +- src/lombok/javac/HandlerLibrary.java | 6 +++--- src/lombok/javac/JavacASTVisitor.java | 2 +- 15 files changed, 42 insertions(+), 42 deletions(-) (limited to 'src') diff --git a/src/lombok/Cleanup.java b/src/lombok/Cleanup.java index 4c3838f2..7d0fcc3c 100644 --- a/src/lombok/Cleanup.java +++ b/src/lombok/Cleanup.java @@ -30,12 +30,12 @@ import java.lang.annotation.Target; * Ensures the variable declaration that you annotate will be cleaned up by calling its close method, regardless * of what happens. Implemented by wrapping all statements following the local variable declaration to the * end of your scope into a try block that, as a finally action, closes the resource. - * + *

* Example: * 

  * public void copyFile(String in, String out) throws IOException {
- *     @Cleanup FileInputStream inStream = new FileInputStream(in);
- *     @Cleamup FileOutputStream outStream = new FileOutputStream(out);
+ *     @Cleanup FileInputStream inStream = new FileInputStream(in);
+ *     @Cleanup FileOutputStream outStream = new FileOutputStream(out);
  *     byte[] b = new byte[65536];
  *     while (true) {
  *         int r = inStream.read(b);
@@ -48,9 +48,9 @@ import java.lang.annotation.Target;
  * Will generate:
  * 
  * public void copyFile(String in, String out) throws IOException {
- *     @Cleanup FileInputStream inStream = new FileInputStream(in);
+ *     @Cleanup FileInputStream inStream = new FileInputStream(in);
  *     try {
- *         @Cleamup FileOutputStream outStream = new FileOutputStream(out);
+ *         @Cleanup FileOutputStream outStream = new FileOutputStream(out);
  *         try {
  *             byte[] b = new byte[65536];
  *             while (true) {
@@ -71,7 +71,7 @@ import java.lang.annotation.Target;
  * in the main body of the generated try block. You should NOT rely on this behaviour - future versions of
  * lombok intend to silently swallow any exception thrown by the cleanup method _IF the main body
  * throws an exception as well, as the earlier exception is usually far more useful.
- * 
+ * 

  * However, in java 1.6, generating the code to do this is prohibitively complicated.
  */
 @Target(ElementType.LOCAL_VARIABLE)
diff --git a/src/lombok/Data.java b/src/lombok/Data.java
index a9a70ee7..7d010e81 100644
--- a/src/lombok/Data.java
+++ b/src/lombok/Data.java
@@ -29,10 +29,10 @@ import java.lang.annotation.Target;
 /**
  * Generates getters for all fields, a useful toString method, and hashCode and equals implementations that check
  * all non-transient fields. Will also generate setters for all non-final fields, as well as a constructor.
- * 
+ * 

  * If any method to be generated already exists (in name - the return type or parameters are not relevant), then
  * that method will not be generated by the Data annotation.
- * 
+ * 

  * toString, equals, and hashCode use the deepX variants in the
  * java.util.Arrays utility class. Therefore, if your class has arrays that contain themselves,
  * these methods will just loop endlessly until the inevitable StackOverflowError. This behaviour
diff --git a/src/lombok/Getter.java b/src/lombok/Getter.java
index 581a252d..f3883efd 100644
--- a/src/lombok/Getter.java
+++ b/src/lombok/Getter.java
@@ -44,7 +44,7 @@ import java.lang.annotation.Target;
  * 
  * Note that fields of type boolean (but not java.lang.Boolean) will result in an
  * isFoo name instead of getFoo.
- * 
+ * 

  * If any method named getFoo/isFoo exists, regardless of return type or parameters, no method is generated,
  * and instead a compiler warning is emitted.
  */
diff --git a/src/lombok/Lombok.java b/src/lombok/Lombok.java
index 400bf3ea..9656b7fd 100644
--- a/src/lombok/Lombok.java
+++ b/src/lombok/Lombok.java
@@ -28,17 +28,17 @@ public class Lombok {
 	/**
 	 * Throws any throwable 'sneakily' - you don't need to catch it, nor declare that you throw it onwards.
 	 * The exception is still thrown - javac will just stop whining about it.
-	 * 
+	 * 

 	 * Example usage:
-	 * 
+	 * 

 	 * 
public void run() {
 	 *     throw sneakyThrow(new IOException("You don't need to catch me!"));
 	 * }

-	 * 
+	 * 

 	 * NB: The exception is not wrapped, ignored, swallowed, or redefined. The JVM actually does not know or care
 	 * about the concept of a 'checked exception'. All this method does is hide the act of throwing a checked exception
 	 * from the java compiler.
-	 * 
+	 * 

 	 * Note that this method has a return type of RuntimeException it is advised you always call this
 	 * method as argument to the throw statement to avoid compiler errors regarding no return
 	 * statement and similar problems. This method won't of course return an actual RuntimeException -
diff --git a/src/lombok/Setter.java b/src/lombok/Setter.java
index 9774c5c6..1bc33e1d 100644
--- a/src/lombok/Setter.java
+++ b/src/lombok/Setter.java
@@ -28,7 +28,7 @@ import java.lang.annotation.Target;
 
 /**
  * Put on any field to make lombok build a standard setter.
- * 
+ * 

  * Example:
  * 
  *     private @Setter int foo;
diff --git a/src/lombok/SneakyThrows.java b/src/lombok/SneakyThrows.java
index 409429ea..62d2c752 100644
--- a/src/lombok/SneakyThrows.java
+++ b/src/lombok/SneakyThrows.java
@@ -27,13 +27,13 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
- * Sneaky throw will avoid javac's insistence that you either catch or throw onward any checked exceptions that
+ * @SneakyThrow will avoid javac's insistence that you either catch or throw onward any checked exceptions that
  * statements in your method body declare they generate.
- * 
- * Sneaky throw does not silently swallow, wrap into RuntimeException, or otherwise modify any exceptions of the listed
+ * 

+ * @SneakyThrow does not silently swallow, wrap into RuntimeException, or otherwise modify any exceptions of the listed
  * checked exception types. The JVM does not check for the consistency of the checked exception system; javac does,
  * and this annotation lets you opt out of its mechanism.
- * 
+ * 

  * You should use this annotation ONLY in the following two cases:
    
  * 
  1. You are certain the listed exception can't actually ever happen, or only in vanishingly rare situations.
  * You don't try to catch OutOfMemoryError on every statement either. Examples:
    
@@ -42,23 +42,23 @@ import java.lang.annotation.Target;
  * 
  2. You know for certain the caller can handle the exception (for example, because the caller is
  * an app manager that will handle all throwables that fall out of your method the same way), but due
  * to interface restrictions you can't just add these exceptions to your 'throws' clause.
- * 
+ * 
    
  * Note that, as SneakyThrow is an implementation detail and NOT part of your method signature, it is
  * a compile time error if none of the statements in your method body can throw a listed exception.
- * 
+ * 
    
  * WARNING: You must have lombok.jar available at the runtime of your app if you use SneakyThrows,
- * because your code is rewritten to use {@link Lombok.sneakyThrow(Throwable)}. 
- * 
- * 
+ * because your code is rewritten to use {@link Lombok#sneakyThrow(Throwable)}. 
+ * 
    
+ * 
    
  * Example:
  * 
    - * @SneakyThrows(UnsupportedEncodingException.class)
+ * @SneakyThrows(UnsupportedEncodingException.class)
  * public void utf8ToString(byte[] bytes) {
  *     return new String(bytes, "UTF-8");
  * }
  * 
    
  * 
- * @see Lombok.sneakyThrow(Throwable)
+ * @see Lombok#sneakyThrow(Throwable)
  */
 @Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
 @Retention(RetentionPolicy.SOURCE)
diff --git a/src/lombok/Synchronized.java b/src/lombok/Synchronized.java
index 655f95e4..91b3827c 100644
--- a/src/lombok/Synchronized.java
+++ b/src/lombok/Synchronized.java
@@ -30,7 +30,7 @@ import java.lang.annotation.Target;
  * Almost exactly like putting the 'synchronized' keyword on a method, except will synchronize on a private internal
  * Object, so that other code not under your control doesn't meddle with your thread management by locking on
  * your own instance.
- * 
+ * 
    
  * For non-static methods, a field named $lock is used, and for static methods,
  * $LOCK is used. These will be generated if needed and if they aren't already present. The contents
  * of the fields will be serializable.
diff --git a/src/lombok/core/AST.java b/src/lombok/core/AST.java
index ef752d1a..b43947c4 100644
--- a/src/lombok/core/AST.java
+++ b/src/lombok/core/AST.java
@@ -205,9 +205,9 @@ public abstract class AST {
 		protected abstract boolean calculateIsStructurallySignificant();
 		
 		/**
-		 * Convenient shortcut to the owning JavacAST object's getNodeFor method.
+		 * Convenient shortcut to the owning JavacAST object's get method.
 		 * 
-		 * @see AST#getNodeFor()
+		 * @see AST#get(Object)
 		 */
 		public Node getNodeFor(N obj) {
 			return AST.this.get(obj);
diff --git a/src/lombok/core/AnnotationValues.java b/src/lombok/core/AnnotationValues.java
index ee434f1f..7056b02f 100644
--- a/src/lombok/core/AnnotationValues.java
+++ b/src/lombok/core/AnnotationValues.java
@@ -287,7 +287,7 @@ public class AnnotationValues {
 	}
 	
 	/**
-	 * Convenience method to return the first result in a {@link getRawExpressions(String)} call.
+	 * Convenience method to return the first result in a {@link #getRawExpressions(String)} call.
 	 * 
 	 * You should use this method if the annotation method is not an array type.
 	 */
@@ -311,7 +311,7 @@ public class AnnotationValues {
 	}
 	
 	/**
-	 * Convenience method to return the first result in a {@link getProbableFQType(String)} call.
+	 * Convenience method to return the first result in a {@link #getProbableFQType(String)} call.
 	 * 
 	 * You should use this method if the annotation method is not an array type.
 	 */
diff --git a/src/lombok/eclipse/EclipseAST.java b/src/lombok/eclipse/EclipseAST.java
index cb530f0e..895f2270 100644
--- a/src/lombok/eclipse/EclipseAST.java
+++ b/src/lombok/eclipse/EclipseAST.java
@@ -355,7 +355,7 @@ public class EclipseAST extends AST {
 		/**
 		 * Convenient shortcut to the owning EclipseAST object's isCompleteParse method.
 		 * 
-		 * @see JavacAST#isCompleteParse()
+		 * @see EclipseAST#isCompleteParse()
 		 */
 		public boolean isCompleteParse() {
 			return completeParse;
diff --git a/src/lombok/eclipse/EclipseASTVisitor.java b/src/lombok/eclipse/EclipseASTVisitor.java
index ac4ed238..726d31f5 100644
--- a/src/lombok/eclipse/EclipseASTVisitor.java
+++ b/src/lombok/eclipse/EclipseASTVisitor.java
@@ -124,7 +124,7 @@ public interface EclipseASTVisitor {
 		/**
 		 * @param printContent if true, method and initializer bodies are printed directly, as java code,
 		 * instead of a tree listing of every AST node inside it.
-		 * @param PrintStream write output to this stream. You must close it yourself. flush() is called after every line.
+		 * @param out write output to this stream. You must close it yourself. flush() is called after every line.
 		 * 
 		 * @see java.io.PrintStream#flush()
 		 */
diff --git a/src/lombok/eclipse/HandlerLibrary.java b/src/lombok/eclipse/HandlerLibrary.java
index b319f580..8ee7d032 100644
--- a/src/lombok/eclipse/HandlerLibrary.java
+++ b/src/lombok/eclipse/HandlerLibrary.java
@@ -146,11 +146,11 @@ public class HandlerLibrary {
 	 * 
 	 * 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}
+	 * Getter refers to lombok.Getter, presuming that {@link lombok.eclipse.handlers.HandleGetter}
 	 * has been loaded.
 	 * 
-	 * @param unit The Compilation Unit that contains the Annotation AST Node.
-	 * @param node The Lombok AST Node representing the Annotation AST Node.
+	 * @param ast The Compilation Unit that contains the Annotation AST Node.
+	 * @param annotationNode The Lombok AST Node representing the Annotation AST Node.
 	 * @param annotation 'node.get()' - convenience parameter.
 	 */
 	public boolean handle(CompilationUnitDeclaration ast, EclipseAST.Node annotationNode,
@@ -198,13 +198,13 @@ public class HandlerLibrary {
 	 * random right now. This lack of order is particularly annoying for the PrintAST annotation,
 	 * which is almost always intended to run last. Hence, this hack, which lets it in fact run last.
 	 * 
-	 * {@see #skipAllButPrintAST}
+	 * @see #skipAllButPrintAST()
 	 */
 	public void skipPrintAST() {
 		skipPrintAST = true;
 	}
 	
-	/** {@see #skipPrintAST} */
+	/** @see #skipPrintAST() */
 	public void skipAllButPrintAST() {
 		skipPrintAST = false;
 	}
diff --git a/src/lombok/installer/Installer.java b/src/lombok/installer/Installer.java
index 5d644868..1b82eb32 100644
--- a/src/lombok/installer/Installer.java
+++ b/src/lombok/installer/Installer.java
@@ -136,7 +136,7 @@ public class Installer {
 	
 	/**
 	 * Creates a new installer that starts out invisible.
-	 * Call the {@see #show()} method on a freshly created installer to render it.
+	 * Call the {@link #show()} method on a freshly created installer to render it.
 	 */
 	public Installer() {
 		appWindow = new JFrame(String.format("Project Lombok v%s - Installer", Version.getVersion()));
diff --git a/src/lombok/javac/HandlerLibrary.java b/src/lombok/javac/HandlerLibrary.java
index f73b9930..7253cbaa 100644
--- a/src/lombok/javac/HandlerLibrary.java
+++ b/src/lombok/javac/HandlerLibrary.java
@@ -151,7 +151,7 @@ public class HandlerLibrary {
 	/**
 	 * Handles the provided annotation node by first finding a qualifying instance of
 	 * {@link JavacAnnotationHandler} and if one exists, calling it with a freshly cooked up
-	 * instance of {@link AnnotationValues}.
+	 * 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.
@@ -203,13 +203,13 @@ public class HandlerLibrary {
 	 * random right now. This lack of order is particularly annoying for the PrintAST annotation,
 	 * which is almost always intended to run last. Hence, this hack, which lets it in fact run last.
 	 * 
-	 * {@see #skipAllButPrintAST}
+	 * @see #skipAllButPrintAST()
 	 */
 	public void skipPrintAST() {
 		skipPrintAST = true;
 	}
 	
-	/** {@see #skipPrintAST} */
+	/** @see #skipPrintAST() */
 	public void skipAllButPrintAST() {
 		skipPrintAST = false;
 	}
diff --git a/src/lombok/javac/JavacASTVisitor.java b/src/lombok/javac/JavacASTVisitor.java
index ac953974..0d751c52 100644
--- a/src/lombok/javac/JavacASTVisitor.java
+++ b/src/lombok/javac/JavacASTVisitor.java
@@ -114,7 +114,7 @@ public interface JavacASTVisitor {
 		/**
 		 * @param printContent if true, method and initializer bodies are printed directly, as java code,
 		 * instead of a tree listing of every AST node inside it.
-		 * @param PrintStream write output to this stream. You must close it yourself. flush() is called after every line.
+		 * @param out write output to this stream. You must close it yourself. flush() is called after every line.
 		 * 
 		 * @see java.io.PrintStream#flush()
 		 */
-- 
cgit