svn commit: r1126715 - in /ofbiz/trunk/framework/entity/src/org/ofbiz/entity: jdbc/JdbcValueHandler.java jdbc/SQLProcessor.java serialize/XmlSerializer.java

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn commit: r1126715 - in /ofbiz/trunk/framework/entity/src/org/ofbiz/entity: jdbc/JdbcValueHandler.java jdbc/SQLProcessor.java serialize/XmlSerializer.java

mrisaliti
Author: mrisaliti
Date: Mon May 23 20:23:32 2011
New Revision: 1126715

URL: http://svn.apache.org/viewvc?rev=1126715&view=rev
Log:
Removed some javadoc warning (wrong param/return) into entity component no functional changes

Modified:
    ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/JdbcValueHandler.java
    ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/SQLProcessor.java
    ofbiz/trunk/framework/entity/src/org/ofbiz/entity/serialize/XmlSerializer.java

Modified: ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/JdbcValueHandler.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/JdbcValueHandler.java?rev=1126715&r1=1126714&r2=1126715&view=diff
==============================================================================
--- ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/JdbcValueHandler.java (original)
+++ ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/JdbcValueHandler.java Mon May 23 20:23:32 2011
@@ -241,7 +241,7 @@ public abstract class JdbcValueHandler<T
 
     /**
      * Returns the SQL type for this handler.
-     * @return
+     * @return return the SQL type
      * @see <code>java.sql.Types</code>
      */
     public int getSqlType() {
@@ -252,9 +252,9 @@ public abstract class JdbcValueHandler<T
      * object is converted to the Java data type specified in the fieldtype
      * file.
      *
-     * @param rs
-     * @param columnIndex
-     * @return
+     * @param rs the ResultSet object
+     * @param columnIndex the column index
+     * @return get value from result set
      * @throws SQLException
      */
     public abstract T getValue(ResultSet rs, int columnIndex) throws SQLException;
@@ -262,8 +262,8 @@ public abstract class JdbcValueHandler<T
     /**
      * Returns a new instance of the object - initialized with
      * the specified SQL type.
-     * @param sqlType
-     * @return
+     * @param sqlType the sql type
+     * @return returns a new instance
      */
     protected abstract JdbcValueHandler<T> newInstance(int sqlType);
 

Modified: ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/SQLProcessor.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/SQLProcessor.java?rev=1126715&r1=1126714&r2=1126715&view=diff
==============================================================================
--- ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/SQLProcessor.java (original)
+++ ofbiz/trunk/framework/entity/src/org/ofbiz/entity/jdbc/SQLProcessor.java Mon May 23 20:23:32 2011
@@ -87,7 +87,7 @@ public class SQLProcessor {
     /**
      * Construct an object based on the helper/datasource
      *
-     * @param helperName  The datasource helper (see entityengine.xml &lt;datasource name=".."&gt;)
+     * @param helperInfo  The datasource helper (see entityengine.xml &lt;datasource name=".."&gt;)
      */
     public SQLProcessor(GenericHelperInfo helperInfo) {
         this.helperInfo = helperInfo;
@@ -98,7 +98,7 @@ public class SQLProcessor {
      * Construct an object with an connection given. The connection will not
      * be closed by this SQLProcessor, but may be by some other.
      *
-     * @param helperName  The datasource helper (see entityengine.xml &lt;datasource name=".."&gt;)
+     * @param helperInfo  The datasource helper (see entityengine.xml &lt;datasource name=".."&gt;)
      * @param connection  The connection to be used
      */
     public SQLProcessor(GenericHelperInfo helperInfo, Connection connection) {

Modified: ofbiz/trunk/framework/entity/src/org/ofbiz/entity/serialize/XmlSerializer.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/org/ofbiz/entity/serialize/XmlSerializer.java?rev=1126715&r1=1126714&r2=1126715&view=diff
==============================================================================
--- ofbiz/trunk/framework/entity/src/org/ofbiz/entity/serialize/XmlSerializer.java (original)
+++ ofbiz/trunk/framework/entity/src/org/ofbiz/entity/serialize/XmlSerializer.java Mon May 23 20:23:32 2011
@@ -81,9 +81,9 @@ public class XmlSerializer {
      * If the XML string contains a serialized <code>GenericValue</code> or <code>GenericPK</code>
      * then it is possible to unintentionally corrupt the database.</p>
      *
-     * @param content
-     * @param delegator
-     * @return
+     * @param content the content
+     * @param delegator the delegator
+     * @return return a deserialized object from XML string
      * @throws SerializeException
      * @throws SAXException
      * @throws ParserConfigurationException
@@ -109,9 +109,9 @@ public class XmlSerializer {
      * contains a serialized <code>GenericValue</code> or <code>GenericPK</code>
      * then it is possible to unintentionally corrupt the database.</p>
      *
-     * @param document
-     * @param delegator
-     * @return
+     * @param document the document
+     * @param delegator the delegator
+     * @return returns a deserialized object from a DOM document
      * @throws SerializeException
      */
     public static Object deserialize(Document document, Delegator delegator) throws SerializeException {