Api Docs clarify the connection between MongoCollection and the CodecRegistry

rozza · rozza · commit a92afc8eae8a · 2015-09-04T14:16:44.000+01:00
JAVA-1859
diff --git a/driver-async/src/main/com/mongodb/async/client/MongoCollection.java b/driver-async/src/main/com/mongodb/async/client/MongoCollection.java
@@ -43,8 +43,13 @@
 
 /**
  * The MongoCollection interface.
- * <p>
- Note: Additions to this interface will not be considered to break binary compatibility.
+ *
+ * <p>Note: Additions to this interface will not be considered to break binary compatibility.</p>
+ *
+ * <p>MongoCollection is generic allowing for different types to represent documents. Any custom classes must have a
+ * {@link org.bson.codecs.Codec} registered in the {@link CodecRegistry}. The default {@code CodecRegistry} includes built-in support for:
+ * {@link org.bson.BsonDocument} and {@link Document}.
+ * </p>
  *
  * @param <TDocument> The type that this collection will encode documents from and decode documents to.
  * @since 3.0
diff --git a/driver/src/main/com/mongodb/client/MongoCollection.java b/driver/src/main/com/mongodb/client/MongoCollection.java
@@ -45,6 +45,11 @@
  *
  * <p>Note: Additions to this interface will not be considered to break binary compatibility.</p>
  *
+ * <p>MongoCollection is generic allowing for different types to represent documents. Any custom classes must have a
+ * {@link org.bson.codecs.Codec} registered in the {@link CodecRegistry}. The default {@code CodecRegistry} includes built-in support for:
+ * {@link org.bson.BsonDocument}, {@link Document} and {@link com.mongodb.DBObject}.
+ * </p>
+ *
  * @param <TDocument> The type that this collection will encode documents from and decode documents to.
  * @since 3.0
  */

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,11 @@`
`45`	`45`	`*`
`46`	`46`	`* <p>Note: Additions to this interface will not be considered to break binary compatibility.</p>`
`47`	`47`	`*`
	`48`	`+ * <p>MongoCollection is generic allowing for different types to represent documents. Any custom classes must have a`
	`49`	`+ * {@link org.bson.codecs.Codec} registered in the {@link CodecRegistry}. The default {@code CodecRegistry} includes built-in support for:`
	`50`	`+ * {@link org.bson.BsonDocument}, {@link Document} and {@link com.mongodb.DBObject}.`
	`51`	`+ * </p>`
	`52`	`+ *`
`48`	`53`	`* @param <TDocument> The type that this collection will encode documents from and decode documents to.`
`49`	`54`	`* @since 3.0`
`50`	`55`	`*/`