Mikeward's Javadoc fixes. Mike read through all of our Javadoc (thank you!) and found a few typos and simplifications
git-svn-id: https://google-guice.googlecode.com/svn/trunk@742 d779f126-a31b-0410-b53b-1d3aecad763e
diff --git a/extensions/assistedinject/src/com/google/inject/assistedinject/AssistedInject.java b/extensions/assistedinject/src/com/google/inject/assistedinject/AssistedInject.java
index 478e73c..33569d7 100755
--- a/extensions/assistedinject/src/com/google/inject/assistedinject/AssistedInject.java
+++ b/extensions/assistedinject/src/com/google/inject/assistedinject/AssistedInject.java
@@ -22,8 +22,8 @@
import java.lang.annotation.Target;
/**
- * <p>Constructors annotated with {@code @AssistedInject} indicate that will can be instantiated by
- * the {@link FactoryProvider}. Each constructor must exactly one corresponding factory method
+ * <p>Constructors annotated with {@code @AssistedInject} indicate that they can be instantiated by
+ * the {@link FactoryProvider}. Each constructor must exactly match one corresponding factory method
* within the factory interface.
*
* <p>Constructor parameters must be either supplied by the factory interface and marked with
@@ -40,4 +40,4 @@
@Target({CONSTRUCTOR})
@Retention(RUNTIME)
@Deprecated
-public @interface AssistedInject {}
\ No newline at end of file
+public @interface AssistedInject {}
diff --git a/extensions/commands/src/com/google/inject/commands/intercepting/InterceptingInjectorBuilder.java b/extensions/commands/src/com/google/inject/commands/intercepting/InterceptingInjectorBuilder.java
index 57514f7..3411e6f 100644
--- a/extensions/commands/src/com/google/inject/commands/intercepting/InterceptingInjectorBuilder.java
+++ b/extensions/commands/src/com/google/inject/commands/intercepting/InterceptingInjectorBuilder.java
@@ -30,6 +30,7 @@
import com.google.inject.Module;
import com.google.inject.ProvidedBy;
import com.google.inject.Provider;
+import com.google.inject.Provides;
import com.google.inject.TypeLiteral;
import com.google.inject.binder.ScopedBindingBuilder;
import com.google.inject.internal.UniqueAnnotations;
@@ -59,8 +60,8 @@
* <pre class="code">bind(MyServiceClass.class);</pre>
*
* <p>All intercepted bindings must be bound explicitly. Interception cannot
- * be applied to implicit bindings, or bindings that depend on
- * {@literal @}{@link ProvidedBy}, {@literal @}{@link ImplementedBy}
+ * be applied to implicit bindings, or bproindings that depend on
+ * {@literal @}{@link ProvidedBy}, {@literal @}{@link ImplementedBy}, {@literal @}{@link Provides}
* annotations.
*
* <p><strong>Implementation note:</strong> To intercept provision, an
diff --git a/extensions/multibindings/src/com/google/inject/multibindings/MapBinder.java b/extensions/multibindings/src/com/google/inject/multibindings/MapBinder.java
index dd3b77e..34abcfa 100644
--- a/extensions/multibindings/src/com/google/inject/multibindings/MapBinder.java
+++ b/extensions/multibindings/src/com/google/inject/multibindings/MapBinder.java
@@ -74,9 +74,9 @@
*
* <p>Values are resolved at map injection time. If a value is bound to a
* provider, that provider's get method will be called each time the map is
- * injected (unless the binding is also scoped).
+ * injected (unless the binding is also scoped, or a map of providers is injected).
*
- * <p>Annotations are be used to create different maps of the same key/value
+ * <p>Annotations are used to create different maps of the same key/value
* type. Each distinct annotation gets its own independent map.
*
* <p><strong>Keys must be distinct.</strong> If the same key is bound more than
diff --git a/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingProviderBinder.java b/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingProviderBinder.java
index 057520b..f73f9a2 100644
--- a/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingProviderBinder.java
+++ b/extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingProviderBinder.java
@@ -35,7 +35,7 @@
import java.lang.reflect.TypeVariable;
/**
- * <p>Builds a binding for an {@link ThrowingProvider} using a fluent API:
+ * <p>Builds a binding for a {@link ThrowingProvider} using a fluent API:
* <pre><code>ThrowingProviderBinder.create(binder())
* .bind(RemoteProvider.class, Customer.class)
* .to(RemoteCustomerProvider.class)
diff --git a/src/com/google/inject/Binder.java b/src/com/google/inject/Binder.java
index 4b98707..c09f324 100644
--- a/src/com/google/inject/Binder.java
+++ b/src/com/google/inject/Binder.java
@@ -38,10 +38,10 @@
* Guice uses an <i>embedded domain-specific language</i>, or EDSL, to help you
* create bindings simply and readably. This approach is great for overall
* usability, but it does come with a small cost: <b>it is difficult to
- * learn how to use the Binding EDSL in the usual way -- by reading
- * method-level javadocs</b>. Instead, you should consult this series of
+ * learn how to use the Binding EDSL by reading
+ * method-level javadocs</b>. Instead, you should consult the series of
* examples below. To save space, these examples omit the opening
- * {@code binder.}, just as you will if your module extends
+ * {@code binder}, just as you will if your module extends
* {@link AbstractModule}.
*
* <pre>
@@ -132,7 +132,7 @@
* In this example, your module itself, <i>not Guice</i>, takes responsibility
* for obtaining a {@code ServiceImpl} instance, then asks Guice to always use
* this single instance to fulfill all {@code Service} injection requests. When
- * the {@link Injector} is first created, it will automatically perform field
+ * the {@link Injector} is created, it will automatically perform field
* and method injection for this instance, but any injectable constructor on
* {@code ServiceImpl} is simply ignored. Note that using this approach results
* in "eager loading" behavior that you can't control.
diff --git a/src/com/google/inject/Guice.java b/src/com/google/inject/Guice.java
index 0a87e7f..8a4c48c 100644
--- a/src/com/google/inject/Guice.java
+++ b/src/com/google/inject/Guice.java
@@ -63,7 +63,7 @@
* Creates an injector for the given set of modules.
*
* @throws CreationException if one or more errors occur during Injector
- * construction
+ * creation
*/
public static Injector createInjector(Iterable<? extends Module> modules) {
return createInjector(Stage.DEVELOPMENT, modules);
@@ -74,7 +74,7 @@
* stage.
*
* @throws CreationException if one or more errors occur during Injector
- * construction
+ * creation
*/
public static Injector createInjector(Stage stage, Module... modules) {
return createInjector(stage, Arrays.asList(modules));
diff --git a/src/com/google/inject/Module.java b/src/com/google/inject/Module.java
index 10fcdc0..f22d93f 100644
--- a/src/com/google/inject/Module.java
+++ b/src/com/google/inject/Module.java
@@ -33,7 +33,7 @@
public interface Module {
/**
- * Contributes bindings and other configurations for this module to a {@code Binder}.
+ * Contributes bindings and other configurations for this module to {@code binder}.
*
* <p><strong>Do not invoke this method directly</strong> to install submodules. Instead use
* {@link Binder#install(Module)}, which ensures that {@link Provides provider methods} are
diff --git a/src/com/google/inject/Provider.java b/src/com/google/inject/Provider.java
index b485b8b..bedaea8 100644
--- a/src/com/google/inject/Provider.java
+++ b/src/com/google/inject/Provider.java
@@ -38,7 +38,7 @@
* for a given key, via the {@link Injector#getProvider} methods.
* </ul>
*
- * @param <T> the type of object this provider provides
+ * @param <T> the type of object this provides
*
* @author crazybob@google.com (Bob Lee)
*/
diff --git a/src/com/google/inject/binder/PrivateBinder.java b/src/com/google/inject/binder/PrivateBinder.java
index d87183c..97d11e1 100644
--- a/src/com/google/inject/binder/PrivateBinder.java
+++ b/src/com/google/inject/binder/PrivateBinder.java
@@ -30,7 +30,7 @@
public interface PrivateBinder extends Binder {
/** Makes the binding for {@code key} available to the enclosing environment */
- void expose(Key<?> type);
+ void expose(Key<?> key);
/**
* Makes a binding for {@code type} available to the enclosing environment. Use {@link
diff --git a/src/com/google/inject/spi/Elements.java b/src/com/google/inject/spi/Elements.java
index 85a86a1..b999b7d 100644
--- a/src/com/google/inject/spi/Elements.java
+++ b/src/com/google/inject/spi/Elements.java
@@ -278,8 +278,8 @@
return new RecordingBinder(this, privateEnvironment);
}
- public void expose(Key<?> type) {
- exposeInternal(type);
+ public void expose(Key<?> key) {
+ exposeInternal(key);
}
public AnnotatedElementBuilder expose(Class<?> type) {
