Added some Javadoc in org.bson

jyemin · jyemin · commit 3f7ca6b967af · 2014-08-06T10:54:09.000-04:00
diff --git a/driver/src/main/org/bson/BSONCallback.java b/driver/src/main/org/bson/BSONCallback.java
@@ -21,7 +21,7 @@
 import org.bson.types.ObjectId;
 
 /**
- * TODO Documentation
+ * A callback interface for describing the structure of a BSON document.
  */
 public interface BSONCallback {
 
diff --git a/driver/src/main/org/bson/BSONDecoder.java b/driver/src/main/org/bson/BSONDecoder.java
@@ -20,15 +20,42 @@
 import java.io.InputStream;
 
 /**
- * TODO Documentation
+ * An interface for decoders of BSON documents.
  */
 public interface BSONDecoder {
 
+    /**
+     * Read a single BSON object from the given bytes.
+     *
+     * @param bytes the bytes in BSON format
+     * @return the BSON object for the given bytes
+     */
     BSONObject readObject(byte[] bytes);
 
+    /**
+     * Read a single BSON object from the given input stream.
+     *
+     * @param in the input stream in BSON format
+     * @return the BSON object for the given bytes
+     */
     BSONObject readObject(InputStream in) throws IOException;
 
+    /**
+     * Decode a single BSON object into the given callback from the given byte array.
+     *
+     * @param bytes the bytes in BSON format
+     * @param callback the callback
+     * @return the number of bytes in the BSON object
+     */
     int decode(byte[] bytes, BSONCallback callback);
 
+    /**
+     * Decode a single BSON object into the given callback from the given input stream.
+     *
+     * @param in the input stream in BSON format
+     * @param callback the callback
+     * @return the number of bytes read from the input tream
+     * @throws IOException
+     */
     int decode(InputStream in, BSONCallback callback) throws IOException;
 }
diff --git a/driver/src/main/org/bson/BasicBSONCallback.java b/driver/src/main/org/bson/BasicBSONCallback.java
@@ -34,7 +34,7 @@
 import java.util.regex.Pattern;
 
 /**
- * TODO Documentation
+ * An implementation of {@code BsonCallback} that creates an instance of BSONObject.
  */
 public class BasicBSONCallback implements BSONCallback {
 
