svn commit: r530912 - in /db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc: ClobStreamControl.java ClobUtf8Writer.java

[kr...@apache.org]

Author: kristwaa
Date: Fri Apr 20 13:45:57 2007
New Revision: 530912

URL: http://svn.apache.org/viewvc?view=rev&rev=530912
Log:
DERBY-2346 (partial): Small JavaDoc cleanup, removing the JavaDoc warnings.

Modified:
    db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobStreamControl.java
    db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobUtf8Writer.java

Modified: db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobStreamControl.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobStreamControl.java?view=diff&rev=530912&r1=530911&r2=530912
==============================================================================
--- db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobStreamControl.java (original)
+++ db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobStreamControl.java Fri Apr 20 13:45:57 2007
@@ -103,10 +103,13 @@
     }
     
     /**
-     * constructs and reurns a reader.
-     * @param pos 
-     * @return 
-     * @throws IOException, SQLException
+     * Construct and return a <code>Reader</code>.
+     * @param pos initial position of the returned <code>Reader</code> in
+     *      number of characters
+     * @return A <code>Reader</code> with the underlying <code>CLOB</code>
+     *      value as source.
+     * @throws IOException
+     * @throws SQLException
      */
     Reader getReader (long pos) throws IOException, SQLException {
         Reader isr = new ClobUpdateableReader (
@@ -120,11 +123,12 @@
     }    
     
     /**
-     * returns a substring.
+     * Returns a substring.
      * @param bIndex 
      * @param eIndex 
-     * @return 
-     * @throws IOException, SQLException
+     * @return A substring of the <code>CLOB</code> value.
+     * @throws IOException
+     * @throws SQLException
      */
     synchronized String getSubstring (long bIndex, long eIndex) 
                                             throws IOException, SQLException {
@@ -158,8 +162,8 @@
     }
     
     /**
-     * returns the size of clob in bytes.
-     * @return 
+     * Returns the size of the Clob in bytes.
+     * @return Number of bytes in the <code>CLOB</code> value.
      * @throws IOException
      */
     long getByteLength () throws IOException {

Modified: db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobUtf8Writer.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobUtf8Writer.java?view=diff&rev=530912&r1=530911&r2=530912
==============================================================================
--- db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobUtf8Writer.java (original)
+++ db/derby/code/trunk/java/engine/org/apache/derby/impl/jdbc/ClobUtf8Writer.java Fri Apr 20 13:45:57 2007
@@ -32,14 +32,13 @@
  */
 final class ClobUtf8Writer extends Writer {
     private ClobStreamControl control;    
-    private long pos; //postion in bytes
+    private long pos; // Position in bytes.
     private boolean closed;
     
     /**
      * Constructor.
      * @param control 
      * @param pos 
-     * @return 
      */
     ClobUtf8Writer(ClobStreamControl control, long pos) {
         this.control = control;