Added javadoc and/or complied with checkstyle rules.
git-svn-id: https://google-web-toolkit.googlecode.com/svn/trunk@80 8db76d5a-ed1c-0410-87a9-c151d255dfc7
diff --git a/dev/core/src/com/google/gwt/dev/GWTShell.java b/dev/core/src/com/google/gwt/dev/GWTShell.java
index 9c1ff34..334d742 100644
--- a/dev/core/src/com/google/gwt/dev/GWTShell.java
+++ b/dev/core/src/com/google/gwt/dev/GWTShell.java
@@ -467,7 +467,9 @@
int prt = getPort();
if (prt != 80 && prt != 0) {
+ // CHECKSTYLE_OFF: Not really an assembled error message, so no space after ':'.
return "http://localhost:" + prt + "/" + unknownUrlText;
+ // CHECKSTYLE_ON
} else {
return "http://localhost/" + unknownUrlText;
}
diff --git a/dev/core/src/com/google/gwt/dev/jdt/ByteCode.java b/dev/core/src/com/google/gwt/dev/jdt/ByteCode.java
index f5b55c1..aee8fcf 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/ByteCode.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/ByteCode.java
@@ -19,6 +19,9 @@
import java.io.Serializable;
+/**
+ * Represents bytecode for a cached class.
+ */
public class ByteCode implements Serializable {
private static final String systemString = System.getProperty(
diff --git a/dev/core/src/com/google/gwt/dev/jdt/CompilationUnitProviderWithAlternateSource.java b/dev/core/src/com/google/gwt/dev/jdt/CompilationUnitProviderWithAlternateSource.java
index 0b0bc5a..88c508b 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/CompilationUnitProviderWithAlternateSource.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/CompilationUnitProviderWithAlternateSource.java
@@ -18,6 +18,10 @@
import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.core.ext.typeinfo.CompilationUnitProvider;
+/**
+ * Wraps an existing compilation unit, retaining the metadata of the original
+ * unit but providing modified source.
+ */
public class CompilationUnitProviderWithAlternateSource implements
CompilationUnitProvider {
private final CompilationUnitProvider cup;
diff --git a/dev/core/src/com/google/gwt/dev/jdt/RebindOracle.java b/dev/core/src/com/google/gwt/dev/jdt/RebindOracle.java
index b85ea43..4d79f3f 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/RebindOracle.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/RebindOracle.java
@@ -18,6 +18,9 @@
import com.google.gwt.core.ext.TreeLogger;
import com.google.gwt.core.ext.UnableToCompleteException;
+/**
+ * Abstracts the implementation of making deferred binding decisions.
+ */
public interface RebindOracle {
/**
diff --git a/dev/core/src/com/google/gwt/dev/jdt/RebindPermutationOracle.java b/dev/core/src/com/google/gwt/dev/jdt/RebindPermutationOracle.java
index d514b5a..6695ce6 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/RebindPermutationOracle.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/RebindPermutationOracle.java
@@ -18,6 +18,10 @@
import com.google.gwt.core.ext.TreeLogger;
import com.google.gwt.core.ext.UnableToCompleteException;
+/**
+ * Abstract the process of determining all of the possible deferred binding
+ * answers for a given type.
+ */
public interface RebindPermutationOracle {
/**
diff --git a/dev/core/src/com/google/gwt/dev/jdt/SourceOracle.java b/dev/core/src/com/google/gwt/dev/jdt/SourceOracle.java
index 1f25242..9853ec2 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/SourceOracle.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/SourceOracle.java
@@ -19,6 +19,10 @@
import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.core.ext.typeinfo.CompilationUnitProvider;
+/**
+ * Abstracts the process of determining which source file contains a given Java
+ * type and specifying whether or not a given name is a package.
+ */
public interface SourceOracle {
/**
diff --git a/dev/core/src/com/google/gwt/dev/jdt/SourceOracleOnTypeOracle.java b/dev/core/src/com/google/gwt/dev/jdt/SourceOracleOnTypeOracle.java
index 9e9c371..28a7eba 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/SourceOracleOnTypeOracle.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/SourceOracleOnTypeOracle.java
@@ -20,6 +20,9 @@
import com.google.gwt.core.ext.typeinfo.JClassType;
import com.google.gwt.core.ext.typeinfo.TypeOracle;
+/**
+ * Implements a {@link SourceOracle} in terms of a {@link TypeOracle}.
+ */
public class SourceOracleOnTypeOracle implements SourceOracle {
private final TypeOracle typeOracle;
diff --git a/dev/core/src/com/google/gwt/dev/jdt/StaticCompilationUnitProvider.java b/dev/core/src/com/google/gwt/dev/jdt/StaticCompilationUnitProvider.java
index 673781e..b43e33d 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/StaticCompilationUnitProvider.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/StaticCompilationUnitProvider.java
@@ -17,6 +17,9 @@
import com.google.gwt.core.ext.typeinfo.CompilationUnitProvider;
+/**
+ * Implements a {@link CompilationUnitProvider} as transient (in-memory) source.
+ */
public class StaticCompilationUnitProvider implements CompilationUnitProvider {
private final String packageName;
diff --git a/dev/core/src/com/google/gwt/dev/jdt/TypeRefVisitor.java b/dev/core/src/com/google/gwt/dev/jdt/TypeRefVisitor.java
index baeb129..afbc73e 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/TypeRefVisitor.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/TypeRefVisitor.java
@@ -32,6 +32,9 @@
import org.eclipse.jdt.internal.compiler.lookup.SourceTypeBinding;
import org.eclipse.jdt.internal.compiler.lookup.TypeBinding;
+/**
+ * Walks the AST to determine every location from which a type is referenced.
+ */
public abstract class TypeRefVisitor extends ASTVisitor {
public void endVisit(ArrayQualifiedTypeReference x, BlockScope scope) {
diff --git a/dev/core/src/com/google/gwt/dev/jdt/URLCompilationUnitProvider.java b/dev/core/src/com/google/gwt/dev/jdt/URLCompilationUnitProvider.java
index 6f2a218..c43c723 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/URLCompilationUnitProvider.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/URLCompilationUnitProvider.java
@@ -24,6 +24,9 @@
import java.net.URL;
import java.net.URLConnection;
+/**
+ * Implements {@link CompilationUnitProvider} in terms of a URL.
+ */
public class URLCompilationUnitProvider implements CompilationUnitProvider {
private static File trySimplify(URL url) {
diff --git a/dev/core/src/com/google/gwt/dev/jdt/WebModeCompilerFrontEnd.java b/dev/core/src/com/google/gwt/dev/jdt/WebModeCompilerFrontEnd.java
index 27f31e7..c573983 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/WebModeCompilerFrontEnd.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/WebModeCompilerFrontEnd.java
@@ -27,6 +27,10 @@
import java.util.Iterator;
import java.util.Set;
+/**
+ * Provides a reusable front-end based on the JDT compiler that incorporates
+ * GWT-specific concepts such as JSNI and deferred binding.
+ */
public class WebModeCompilerFrontEnd extends AstCompiler {
private final RebindPermutationOracle rebindPermOracle;
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/CanBeSetFinal.java b/dev/core/src/com/google/gwt/dev/jjs/ast/CanBeSetFinal.java
index d2808f4..5ab2baf 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/CanBeSetFinal.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/CanBeSetFinal.java
@@ -15,6 +15,10 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * Characteristic interface to be overlaid on AST constructs that can retain a
+ * boolean 'final' flag.
+ */
public interface CanBeSetFinal {
void setFinal(boolean b);
}
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/HasInstance.java b/dev/core/src/com/google/gwt/dev/jjs/ast/HasInstance.java
index 6e4caee..d774668 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/HasInstance.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/HasInstance.java
@@ -15,6 +15,10 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * Characteristic interface to be overlaid on AST constructs that can contain
+ * instance expressions.
+ */
public interface HasInstance {
JExpression getInstance();
}
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/HasSettableType.java b/dev/core/src/com/google/gwt/dev/jjs/ast/HasSettableType.java
index b9f600c..1e7fded 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/HasSettableType.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/HasSettableType.java
@@ -15,6 +15,10 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * Characteristic interface to be overlaid on AST constructs that have a type
+ * that can be explicitly set.
+ */
public interface HasSettableType extends HasType {
void setType(JType newType);
}
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/Holder.java b/dev/core/src/com/google/gwt/dev/jjs/ast/Holder.java
index c39f39c..cb7dc51 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/Holder.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/Holder.java
@@ -15,6 +15,9 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * A mutable reference to an AST node.
+ */
public class Holder extends Mutator implements JVisitable {
private JExpression value;
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/HolderList.java b/dev/core/src/com/google/gwt/dev/jjs/ast/HolderList.java
index b2571ad..b571ccf 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/HolderList.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/HolderList.java
@@ -21,10 +21,13 @@
import java.util.List;
import java.util.ListIterator;
+/**
+ * A list of {@link Holder} objects.
+ */
public class HolderList/* <T extends JNode> */implements List/* <T> */,
JVisitable {
- private final class ListIt implements ListIterator/* <T> */ {
+ private final class ListIt implements ListIterator/* <T> */{
private final ListIterator/* <Mutator<T>> */itImpl;
private final ListIterator/* <T> */itPeer;
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/JAbsentArrayDimension.java b/dev/core/src/com/google/gwt/dev/jjs/ast/JAbsentArrayDimension.java
index ff215fa..009116a 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/JAbsentArrayDimension.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/JAbsentArrayDimension.java
@@ -15,6 +15,10 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * Represents an array dimension that was not specified in an array
+ * instantiation expression.
+ */
public class JAbsentArrayDimension extends JLiteral {
/**
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/JExpressionStatement.java b/dev/core/src/com/google/gwt/dev/jjs/ast/JExpressionStatement.java
index dd7ff8a..bb16984 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/JExpressionStatement.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/JExpressionStatement.java
@@ -15,6 +15,9 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * Repesents a statement that is an expression.
+ */
public class JExpressionStatement extends JStatement {
private final Holder expr = new Holder();
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/JUnaryOperator.java b/dev/core/src/com/google/gwt/dev/jjs/ast/JUnaryOperator.java
index 4cb7fab..32a2db5 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/JUnaryOperator.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/JUnaryOperator.java
@@ -15,6 +15,9 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * An enumeration of the available unary operators.
+ */
public class JUnaryOperator {
public static final JUnaryOperator INC = new JUnaryOperator("++");
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/JVisitable.java b/dev/core/src/com/google/gwt/dev/jjs/ast/JVisitable.java
index 6c26fc4..87d2425 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/JVisitable.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/JVisitable.java
@@ -15,6 +15,9 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * Abstracts the idea that a class can be traversed.
+ */
public interface JVisitable {
- void traverse(JVisitor visitor);
+ void traverse(JVisitor visitor);
}
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/Mutator.java b/dev/core/src/com/google/gwt/dev/jjs/ast/Mutator.java
index 9dcfc01..ced4091 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/Mutator.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/Mutator.java
@@ -15,6 +15,9 @@
*/
package com.google.gwt.dev.jjs.ast;
+/**
+ * Abstracts the process of modifying an AST node.
+ */
public abstract class Mutator {
public abstract JExpression get();
diff --git a/dev/core/src/com/google/gwt/dev/jjs/ast/change/ChangeList.java b/dev/core/src/com/google/gwt/dev/jjs/ast/change/ChangeList.java
index 4c453a0..dfea792 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/change/ChangeList.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/change/ChangeList.java
@@ -32,6 +32,9 @@
import java.util.ArrayList;
import java.util.List;
+/**
+ * Manages a list of {@link Change} objects to apply to the AST.
+ */
public class ChangeList extends ChangeBase {
static String getEnclosingTypeString(String prefix, Object x) {
@@ -81,7 +84,8 @@
addNode(x, -1, x.getEnclosingType().methods);
}
- public/* <N extends JNode> */void addNode(JNode x, int index, List/* <N> */list) {
+ public/* <N extends JNode> */void addNode(JNode x, int index,
+ List/* <N> */list) {
AddNode change = new AddNode/* <N> */(x, index, list);
changes.add(change);
}
