svn commit: r373544 - in /beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc: JdbcControlImpl.java TypeMappingsFactory.java

[ek...@apache.org]

Author: ekoneil
Date: Mon Jan 30 08:23:56 2006
New Revision: 373544

URL: http://svn.apache.org/viewcvs?rev=373544&view=rev
Log:
Javadoc fixes -- stops warnings from being reported when docs are generated.

BB: self
Test: build.release.docs pass


Modified:
    beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/JdbcControlImpl.java
    beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/TypeMappingsFactory.java

Modified: beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/JdbcControlImpl.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/JdbcControlImpl.java?rev=373544&r1=373543&r2=373544&view=diff
==============================================================================
--- beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/JdbcControlImpl.java (original)
+++ beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/JdbcControlImpl.java Mon Jan 30 08:23:56 2006
@@ -224,16 +224,16 @@
     }
 
     /**
-     * Sets the calendar used when working with time/date types
+     * Sets the {@link Calendar} used when working with time/date types
      */
     public void setDataSourceCalendar(Calendar cal) {
         _cal = (Calendar) cal.clone();
     }
 
     /**
-     * Returns the calendar used when working with time/date types.
+     * Returns the {@link Calendar} used when working with time/date types.
      *
-     * @return 
+     * @return the {@link Calendar} to use with this {@link DataSource}
      */
     public Calendar getDataSourceCalendar() {
         return _cal;
@@ -243,12 +243,12 @@
 
 
     /**
-     * Create and exec the query
+     * Create and exec a {@link PreparedStatement}
      *
-     * @param method
-     * @param args
-     * @return
-     * @throws Throwable
+     * @param method the method to invoke
+     * @param args the method's arguments
+     * @return the return value from the {@link PreparedStatement}
+     * @throws Throwable any exception that occurs; the caller should handle these appropriately
      */
     protected Object execPreparedStatement(Method method, Object[] args)
             throws Throwable {

Modified: beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/TypeMappingsFactory.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/TypeMappingsFactory.java?rev=373544&r1=373543&r2=373544&view=diff
==============================================================================
--- beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/TypeMappingsFactory.java (original)
+++ beehive/trunk/system-controls/src/jdbc/org/apache/beehive/controls/system/jdbc/TypeMappingsFactory.java Mon Jan 30 08:23:56 2006
@@ -15,11 +15,8 @@
  *
  * $Header:$
  */
-
 package org.apache.beehive.controls.system.jdbc;
 
-import org.apache.beehive.controls.api.ControlException;
-
 import java.lang.reflect.Method;
 import java.lang.reflect.InvocationTargetException;
 import java.sql.Types;
@@ -28,12 +25,15 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import org.apache.beehive.controls.api.ControlException;
+
 /**
  * Currently contains all types of type mappings. Implemented using singleton pattern.
  */
-//@todo: refactor!
 public final class TypeMappingsFactory {
 
+    /* @todo: refactor! */
+
     private static TypeMappingsFactory _instance;
     private static Class<?> XMLBEANS_STRING_ENUM_ABSTRACT_BASE = null;
 
@@ -45,7 +45,6 @@
         }
     }
 
-
     /**
      * Get an instance of this class.
      * @return TypeMappingsFactory instance.
@@ -296,7 +295,7 @@
      *
      * @param val
      * @param args
-     * @return
+     * @return the type
      * @throws IllegalAccessException
      * @throws InvocationTargetException
      */