Added javadoc comments.
git-svn-id: https://google-web-toolkit.googlecode.com/svn/trunk@83 8db76d5a-ed1c-0410-87a9-c151d255dfc7
diff --git a/dev/core/src/com/google/gwt/dev/jdt/FindJsniRefVisitor.java b/dev/core/src/com/google/gwt/dev/jdt/FindJsniRefVisitor.java
index 1ecb5f1..d6a958c 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/FindJsniRefVisitor.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/FindJsniRefVisitor.java
@@ -32,6 +32,9 @@
import java.io.StringReader;
import java.util.Set;
+/**
+ * Walks the AST to find references to Java identifiers from within JSNI blocks.
+ */
public class FindJsniRefVisitor extends ASTVisitor {
private final Set/* <String> */jsniClasses;
diff --git a/dev/core/src/com/google/gwt/dev/jdt/ICompilationUnitAdapter.java b/dev/core/src/com/google/gwt/dev/jdt/ICompilationUnitAdapter.java
index 21cb5c9..bf0ba50 100644
--- a/dev/core/src/com/google/gwt/dev/jdt/ICompilationUnitAdapter.java
+++ b/dev/core/src/com/google/gwt/dev/jdt/ICompilationUnitAdapter.java
@@ -21,6 +21,10 @@
import org.eclipse.jdt.core.compiler.CharOperation;
import org.eclipse.jdt.internal.compiler.env.ICompilationUnit;
+/**
+ * Implements <code>ICompilationUnit</code> in terms of a
+ * {@link CompilationUnitProvider}.
+ */
public class ICompilationUnitAdapter implements ICompilationUnit {
private final CompilationUnitProvider cup;
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 b571ccf..7893e8d 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
@@ -27,7 +27,7 @@
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/js/JMultiExpression.java b/dev/core/src/com/google/gwt/dev/jjs/ast/js/JMultiExpression.java
index de46b8f..c167090 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/ast/js/JMultiExpression.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/ast/js/JMultiExpression.java
@@ -22,6 +22,9 @@
import com.google.gwt.dev.jjs.ast.JVisitor;
import com.google.gwt.dev.jjs.ast.Mutator;
+/**
+ * Represents multiple ordered expressions as a single compound expression.
+ */
public class JMultiExpression extends JExpression {
public HolderList exprs = new HolderList();
@@ -40,7 +43,7 @@
}
public boolean hasSideEffects() {
-
+
for (int i = 0; i < exprs.size(); ++i) {
JExpression expr = exprs.getExpr(i);
if (expr.hasSideEffects()) {
diff --git a/dev/core/src/com/google/gwt/dev/jjs/impl/InternalCompilerException.java b/dev/core/src/com/google/gwt/dev/jjs/impl/InternalCompilerException.java
index d7bd231..c93e1f5 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/impl/InternalCompilerException.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/impl/InternalCompilerException.java
@@ -15,13 +15,17 @@
*/
package com.google.gwt.dev.jjs.impl;
+/**
+ * Indicates the compiler encountered an unexpected and unsupported state of
+ * operation.
+ */
public class InternalCompilerException extends RuntimeException {
- public InternalCompilerException(String message) {
- super(message);
- }
+ public InternalCompilerException(String message) {
+ super(message);
+ }
- public InternalCompilerException(String message, Throwable cause) {
- super(message, cause);
- }
+ public InternalCompilerException(String message, Throwable cause) {
+ super(message, cause);
+ }
}
diff --git a/dev/core/src/com/google/gwt/dev/jjs/impl/TextOutputVisitor.java b/dev/core/src/com/google/gwt/dev/jjs/impl/TextOutputVisitor.java
index 68a5a56..f7a9005 100644
--- a/dev/core/src/com/google/gwt/dev/jjs/impl/TextOutputVisitor.java
+++ b/dev/core/src/com/google/gwt/dev/jjs/impl/TextOutputVisitor.java
@@ -18,6 +18,10 @@
import com.google.gwt.dev.jjs.ast.JVisitor;
import com.google.gwt.dev.util.TextOutput;
+/**
+ * A convenience base class that combines a {@link JVisitor} with a
+ * {@link TextOutput}.
+ */
public class TextOutputVisitor extends JVisitor implements TextOutput {
private final TextOutput textOutput;
diff --git a/dev/core/src/com/google/gwt/dev/js/FullNamingStrategy.java b/dev/core/src/com/google/gwt/dev/js/FullNamingStrategy.java
index f966ea2..fd54afc 100644
--- a/dev/core/src/com/google/gwt/dev/js/FullNamingStrategy.java
+++ b/dev/core/src/com/google/gwt/dev/js/FullNamingStrategy.java
@@ -18,6 +18,10 @@
import com.google.gwt.dev.js.ast.JsObfuscatableName;
import com.google.gwt.dev.js.ast.JsScope;
+/**
+ * Implements a naming strategy that does not alter the standard names of
+ * identifiers.
+ */
public class FullNamingStrategy extends NamingStrategy {
// @Override
diff --git a/dev/core/src/com/google/gwt/dev/js/JsParser.java b/dev/core/src/com/google/gwt/dev/js/JsParser.java
index 6a8f3ff..a33ae9d 100644
--- a/dev/core/src/com/google/gwt/dev/js/JsParser.java
+++ b/dev/core/src/com/google/gwt/dev/js/JsParser.java
@@ -73,6 +73,9 @@
import java.util.Iterator;
import java.util.Stack;
+/**
+ * Parses JavaScript source.
+ */
public class JsParser {
private final Stack scopeStack = new Stack();
diff --git a/dev/core/src/com/google/gwt/dev/js/NamingStrategy.java b/dev/core/src/com/google/gwt/dev/js/NamingStrategy.java
index ee78100..496f5d9 100644
--- a/dev/core/src/com/google/gwt/dev/js/NamingStrategy.java
+++ b/dev/core/src/com/google/gwt/dev/js/NamingStrategy.java
@@ -24,6 +24,10 @@
import java.util.IdentityHashMap;
import java.util.Map;
+/**
+ * Abstracts the process of mapping a standard identifier name onto a possibly
+ * alternative name.
+ */
public abstract class NamingStrategy {
private class RootScopeHandler {
diff --git a/dev/core/src/com/google/gwt/dev/js/ObfuscatedNamingStrategy.java b/dev/core/src/com/google/gwt/dev/js/ObfuscatedNamingStrategy.java
index ebcae5d..3218958 100644
--- a/dev/core/src/com/google/gwt/dev/js/ObfuscatedNamingStrategy.java
+++ b/dev/core/src/com/google/gwt/dev/js/ObfuscatedNamingStrategy.java
@@ -18,6 +18,10 @@
import com.google.gwt.dev.js.ast.JsObfuscatableName;
import com.google.gwt.dev.js.ast.JsScope;
+/**
+ * Implements a naming strategy that obfuscated the standard names of
+ * identifiers.
+ */
public class ObfuscatedNamingStrategy extends NamingStrategy {
private static final char[] sBase64Chars = new char[] {
diff --git a/dev/core/src/com/google/gwt/dev/js/PrettyNamingStrategy.java b/dev/core/src/com/google/gwt/dev/js/PrettyNamingStrategy.java
index 273b888..a91485f 100644
--- a/dev/core/src/com/google/gwt/dev/js/PrettyNamingStrategy.java
+++ b/dev/core/src/com/google/gwt/dev/js/PrettyNamingStrategy.java
@@ -18,6 +18,10 @@
import com.google.gwt.dev.js.ast.JsObfuscatableName;
import com.google.gwt.dev.js.ast.JsScope;
+/**
+ * Implements a naming strategy that simplifies the standard names of
+ * identifiers to make them readable.
+ */
public class PrettyNamingStrategy extends NamingStrategy {
// @Override