Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=48147
authormarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Tue, 17 Nov 2009 22:27:58 +0000 (22:27 +0000)
committermarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Tue, 17 Nov 2009 22:27:58 +0000 (22:27 +0000)
Correct JavaDoc typos. Patch provided by gingyang.xu

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@881575 13f79535-47bb-0310-9956-ffa450edef68

15 files changed:
java/org/apache/naming/NamingEntry.java
java/org/apache/naming/NamingService.java
java/org/apache/naming/NamingServiceMBean.java
java/org/apache/naming/ResourceRef.java
java/org/apache/naming/factory/EjbFactory.java
java/org/apache/naming/factory/OpenEjbFactory.java
java/org/apache/naming/factory/ResourceEnvFactory.java
java/org/apache/naming/factory/TransactionFactory.java
java/org/apache/naming/resources/BaseDirContext.java
java/org/apache/naming/resources/DirContextURLConnection.java
java/org/apache/naming/resources/FileDirContext.java
java/org/apache/naming/resources/ProxyDirContext.java
java/org/apache/naming/resources/Resource.java
java/org/apache/naming/resources/ResourceCache.java
java/org/apache/naming/resources/WARDirContext.java

index 9ef8ac5..0606886 100644 (file)
@@ -53,7 +53,7 @@ public class NamingEntry {
 
 
     /**
-     * The type instance variable is used to avoid unsing RTTI when doing
+     * The type instance variable is used to avoid using RTTI when doing
      * lookups.
      */
     public int type;
index 4e1348b..b26911a 100644 (file)
@@ -93,7 +93,7 @@ public final class NamingService
     
     
     /**
-     * Retruns the Catalina component name.
+     * Returns the Catalina component name.
      */
     public String getName() {
         return NAME;
index 936c8a8..12d312b 100644 (file)
@@ -59,7 +59,7 @@ public interface NamingServiceMBean {
     
     
     /**
-     * Retruns the JNDI component name.
+     * Returns the JNDI component name.
      */
     public String getName();
     
index 922ded0..687b86d 100644 (file)
@@ -72,7 +72,7 @@ public class ResourceRef
      * 
      * @param resourceClass Resource class
      * @param scope Resource scope
-     * @param auth Resource authetication
+     * @param auth Resource authentication
      */
     public ResourceRef(String resourceClass, String description, 
                        String scope, String auth) {
@@ -85,7 +85,7 @@ public class ResourceRef
      * 
      * @param resourceClass Resource class
      * @param scope Resource scope
-     * @param auth Resource authetication
+     * @param auth Resource authentication
      */
     public ResourceRef(String resourceClass, String description, 
                        String scope, String auth, String factory,
index 5a890e2..fec6250 100644 (file)
@@ -55,7 +55,7 @@ public class EjbFactory
 
 
     /**
-     * Crete a new EJB instance.
+     * Create a new EJB instance.
      * 
      * @param obj The reference object describing the DataSource
      */
index ad7db6e..4f615e3 100644 (file)
@@ -50,7 +50,7 @@ public class OpenEjbFactory implements ObjectFactory {
 
 
     /**
-     * Crete a new EJB instance using OpenEJB.
+     * Create a new EJB instance using OpenEJB.
      * 
      * @param obj The reference object describing the DataSource
      */
index 2ebec4b..31a2cdf 100644 (file)
@@ -54,7 +54,7 @@ public class ResourceEnvFactory
 
 
     /**
-     * Crete a new Resource env instance.
+     * Create a new Resource env instance.
      * 
      * @param obj The reference object describing the DataSource
      */
index fefd36a..f933cf3 100644 (file)
@@ -28,7 +28,7 @@ import javax.naming.spi.ObjectFactory;
 import org.apache.naming.TransactionRef;
 
 /**
- * Object factory for User trasactions.
+ * Object factory for User transactions.
  * 
  * @author Remy Maucherat
  * @version $Revision$ $Date$
@@ -54,7 +54,7 @@ public class TransactionFactory
 
 
     /**
-     * Crete a new User transaction instance.
+     * Create a new User transaction instance.
      * 
      * @param obj The reference object describing the DataSource
      */
index f96418f..f95c3de 100644 (file)
@@ -1342,7 +1342,7 @@ public abstract class BaseDirContext implements DirContext {
      * occurrence of "{i}". If null, equivalent to an empty array.
      * @param cons the search controls that control the search. If null, the 
      * default search controls are used (equivalent to (new SearchControls())).
-     * @return an enumeration of SearchResults of the objects that satisy the 
+     * @return an enumeration of SearchResults of the objects that satisfy the 
      * filter; never null
      * @exception ArrayIndexOutOfBoundsException if filterExpr contains {i} 
      * expressions where i is outside the bounds of the array filterArgs
index 0421db7..a1e1f07 100644 (file)
@@ -121,7 +121,7 @@ public class DirContextURLConnection
     
     
     /**
-     * Connect to the DirContext, and retrive the bound object, as well as
+     * Connect to the DirContext, and retrieve the bound object, as well as
      * its attributes. If no object is bound with the name specified in the
      * URL, then an IOException is thrown.
      * 
index 7b43e6e..4da3169 100644 (file)
@@ -750,7 +750,7 @@ public class FileDirContext extends BaseDirContext {
      * occurrence of "{i}". If null, equivalent to an empty array.
      * @param cons the search controls that control the search. If null, the
      * default search controls are used (equivalent to (new SearchControls())).
-     * @return an enumeration of SearchResults of the objects that satisy the
+     * @return an enumeration of SearchResults of the objects that satisfy the
      * filter; never null
      * @exception ArrayIndexOutOfBoundsException if filterExpr contains {i}
      * expressions where i is outside the bounds of the array filterArgs
@@ -847,7 +847,7 @@ public class FileDirContext extends BaseDirContext {
      * List the resources which are members of a collection.
      *
      * @param file Collection
-     * @return Vector containg NamingEntry objects
+     * @return Vector containing NamingEntry objects
      */
     protected ArrayList<NamingEntry> list(File file) {
 
index 78ff574..e649b31 100644 (file)
@@ -1544,7 +1544,7 @@ public class ProxyDirContext implements DirContext {
             }
         }
 
-        // Retriving object
+        // Retrieving object
         if ((exists) && (entry.resource == null) && (entry.context == null)) {
             try {
                 Object object = dirContext.lookup(name);
index 7dc44dc..4a6cec5 100644 (file)
@@ -22,7 +22,7 @@ import java.io.ByteArrayInputStream;
 import java.io.IOException;
 
 /**
- * Encapsultes the contents of a resource.
+ * Encapsulates the contents of a resource.
  * 
  * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
  * @version $Revision$
index 126c617..a3abc3d 100644 (file)
@@ -339,7 +339,7 @@ public class ResourceCache {
 
 
     /**
-     * Find a map elemnt given its name in a sorted array of map elements.
+     * Find a map element given its name in a sorted array of map elements.
      * This will return the index for the closest inferior or equal item in the
      * given array.
      */
index 5480bd9..1aef0ed 100644 (file)
@@ -729,7 +729,7 @@ public class WARDirContext extends BaseDirContext {
      * occurrence of "{i}". If null, equivalent to an empty array.
      * @param cons the search controls that control the search. If null, the 
      * default search controls are used (equivalent to (new SearchControls())).
-     * @return an enumeration of SearchResults of the objects that satisy the 
+     * @return an enumeration of SearchResults of the objects that satisfy the 
      * filter; never null
      * @exception ArrayIndexOutOfBoundsException if filterExpr contains {i} 
      * expressions where i is outside the bounds of the array filterArgs