Added some javadoc for decoders

jyemin · jyemin · commit 3819082b2e33 · 2014-08-06T10:54:10.000-04:00
diff --git a/driver/src/main/com/mongodb/DBDecoder.java b/driver/src/main/com/mongodb/DBDecoder.java
@@ -22,13 +22,35 @@
 import java.io.InputStream;
 
 /**
- * TODO Documentation needed.
+ *  An interface for decoders of BSON into instances of DBObject that belong to a DBCollection.
  */
 public interface DBDecoder extends BSONDecoder {
 
+    /**
+     * Get a callback for the given collection.
+     *
+     * @param collection the collection
+     * @return the callback
+     */
     DBCallback getDBCallback(DBCollection collection);
 
+    /**
+     * Decode a single DBObject belonging to the given collectoin from the given input stream.
+     *
+     * @param in the input stream
+     * @param collection the collection
+     * @return the DBObject
+     * @throws IOException
+     */
     DBObject decode(InputStream in, DBCollection collection) throws IOException;
 
+    /**
+     * Decode a single DBObject belonging to the given collectoin from the given array of bytes.
+     *
+     * @param bytes the byte array
+     * @param collection the collection
+     * @return the DBObject
+     * @throws IOException
+     */
     DBObject decode(byte[] bytes, DBCollection collection);
 }
diff --git a/driver/src/main/com/mongodb/DefaultDBCallback.java b/driver/src/main/com/mongodb/DefaultDBCallback.java
@@ -25,7 +25,7 @@
 import java.util.List;
 
 /**
- * TODO Documentation.
+ * An implementation of DBCallback that decodes into a DBObject.
  */
 public class DefaultDBCallback extends BasicBSONCallback implements DBCallback {
 
diff --git a/driver/src/main/com/mongodb/DefaultDBDecoder.java b/driver/src/main/com/mongodb/DefaultDBDecoder.java
@@ -22,7 +22,7 @@
 import java.io.InputStream;
 
 /**
- * TODO Documentation
+ * An implementation of DBDecoder
  */
 public class DefaultDBDecoder extends BasicBSONDecoder implements DBDecoder {
 
