docs: update several deprecated comments

trnl · trnl · commit d10c777eb791 · 2013-08-15T14:28:49.000+03:00
diff --git a/src/main/com/mongodb/DBCollection.java b/src/main/com/mongodb/DBCollection.java
@@ -1394,7 +1394,7 @@ protected DBCollection( DB base , String name ){
 
     /**
      * @deprecated This method should not be a part of API.
-     *             If you overriding one of the {@code DBCollection} methods please rely on superclass
+     *             If you override one of the {@code DBCollection} methods please rely on superclass
      *             implementation in checking argument correctness and validity.
      */
     @Deprecated
diff --git a/src/main/com/mongodb/DBPort.java b/src/main/com/mongodb/DBPort.java
@@ -53,7 +53,7 @@
  * Methods implemented at the port level should throw the raw exceptions like IOException,
  * so that the connector above can make appropriate decisions on how to handle.
  *
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class DBPort {
diff --git a/src/main/com/mongodb/DBPortPool.java b/src/main/com/mongodb/DBPortPool.java
@@ -36,7 +36,7 @@
 /**
  * This class is NOT part of the public API.  Be prepared for non-binary compatible changes in minor releases.
  *
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class DBPortPool extends SimplePool<DBPort> {
diff --git a/src/main/com/mongodb/Mongo.java b/src/main/com/mongodb/Mongo.java
@@ -426,7 +426,7 @@ public String getVersion(){
      * returns a string representing the hosts used in this Mongo instance
      * @return
      *
-     * @deprecated This method is NOT a part of public API and will be propped in 3.x versions.
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
      */
     @Deprecated
     public String debugString(){
diff --git a/src/main/com/mongodb/RawDBObject.java b/src/main/com/mongodb/RawDBObject.java
@@ -55,7 +55,7 @@
 /**
  * This object wraps the binary object format ("BSON") used for the transport of serialized objects to / from the Mongo database.
  *
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class RawDBObject implements DBObject {
diff --git a/src/main/com/mongodb/io/ByteBufferFactory.java b/src/main/com/mongodb/io/ByteBufferFactory.java
@@ -21,14 +21,14 @@
 import java.nio.ByteBuffer;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public interface ByteBufferFactory {
     public ByteBuffer get();
 
     /**
-     * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+     * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
      */
     @Deprecated
     public static class SimpleHeapByteBufferFactory implements ByteBufferFactory {
diff --git a/src/main/com/mongodb/io/ByteBufferHolder.java b/src/main/com/mongodb/io/ByteBufferHolder.java
@@ -23,7 +23,7 @@
 import java.util.List;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class ByteBufferHolder {
diff --git a/src/main/com/mongodb/io/ByteBufferInputStream.java b/src/main/com/mongodb/io/ByteBufferInputStream.java
@@ -23,7 +23,7 @@
 import java.util.List;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class ByteBufferInputStream extends InputStream {
diff --git a/src/main/com/mongodb/io/ByteBufferOutputStream.java b/src/main/com/mongodb/io/ByteBufferOutputStream.java
@@ -24,7 +24,7 @@
 import java.util.List;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class ByteBufferOutputStream extends OutputStream  {
diff --git a/src/main/com/mongodb/io/ByteStream.java b/src/main/com/mongodb/io/ByteStream.java
@@ -21,7 +21,7 @@
 import java.nio.ByteBuffer;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public interface ByteStream {
diff --git a/src/main/com/mongodb/util/Args.java b/src/main/com/mongodb/util/Args.java
@@ -25,7 +25,7 @@
 
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class Args {
diff --git a/src/main/com/mongodb/util/Base64Codec.java b/src/main/com/mongodb/util/Base64Codec.java
@@ -44,7 +44,7 @@
  * Original Thanks to "commons" project in ws.apache.org for this code.
  * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/
  * </p>
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class Base64Codec {
diff --git a/src/main/com/mongodb/util/FastStack.java b/src/main/com/mongodb/util/FastStack.java
@@ -22,7 +22,7 @@
 import java.util.List;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class FastStack<T>{
diff --git a/src/main/com/mongodb/util/Hash.java b/src/main/com/mongodb/util/Hash.java
@@ -19,7 +19,7 @@
 package com.mongodb.util;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public final class Hash {
diff --git a/src/main/com/mongodb/util/IdentitySet.java b/src/main/com/mongodb/util/IdentitySet.java
@@ -23,7 +23,7 @@
 import java.util.Iterator;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class IdentitySet<T> implements Iterable<T> {
diff --git a/src/main/com/mongodb/util/MyAsserts.java b/src/main/com/mongodb/util/MyAsserts.java
@@ -22,7 +22,7 @@
 import java.util.regex.Pattern;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class MyAsserts {
diff --git a/src/main/com/mongodb/util/OptionMap.java b/src/main/com/mongodb/util/OptionMap.java
@@ -21,7 +21,7 @@
 import java.util.TreeMap;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class OptionMap extends TreeMap<String,String> {
diff --git a/src/main/com/mongodb/util/StringBuilderPool.java b/src/main/com/mongodb/util/StringBuilderPool.java
@@ -19,7 +19,7 @@
 package com.mongodb.util;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class StringBuilderPool extends SimplePool<StringBuilder> {
diff --git a/src/main/com/mongodb/util/StringParseUtil.java b/src/main/com/mongodb/util/StringParseUtil.java
@@ -19,7 +19,7 @@
 package com.mongodb.util;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public final class StringParseUtil {
diff --git a/src/main/com/mongodb/util/ThreadUtil.java b/src/main/com/mongodb/util/ThreadUtil.java
@@ -23,7 +23,7 @@
 import java.util.Map;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class ThreadUtil {
diff --git a/src/main/com/mongodb/util/TimeConstants.java b/src/main/com/mongodb/util/TimeConstants.java
@@ -19,7 +19,7 @@
 package com.mongodb.util;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class TimeConstants {
diff --git a/src/main/com/mongodb/util/UniqueList.java b/src/main/com/mongodb/util/UniqueList.java
@@ -22,7 +22,7 @@
 import java.util.Collection;
 
 /**
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class UniqueList<T> extends ArrayList<T> {
diff --git a/src/main/com/mongodb/util/WeakBag.java b/src/main/com/mongodb/util/WeakBag.java
@@ -27,7 +27,7 @@
 /**
  * if its not obvious what a weak bag should do, then, well...
  * very very not thread safe
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class WeakBag<T> implements Iterable<T> {
diff --git a/src/main/org/bson/BSONLazyDecoder.java b/src/main/org/bson/BSONLazyDecoder.java
@@ -19,7 +19,7 @@
  *
  * @author antoine
  *
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class BSONLazyDecoder {
diff --git a/src/main/org/bson/BasicBSONDecoder.java b/src/main/org/bson/BasicBSONDecoder.java
@@ -52,7 +52,7 @@
  *<h4>Solution 1: Custom {@link BSONCallback} implementation</h4>
  * With callbacks you can handle the process of creating objects from bytes in BSON format.
  * <p>
- * For example to get away of overriging <b>{@code BasicBSONDecoder._binary(String)}</b>
+ * For example to get away from overriging <b>{@code BasicBSONDecoder._binary(String)}</b>
  * you can use the following piece of code:
  * </p>
  * <pre>
@@ -69,7 +69,7 @@
  * This solution covers majority of the cases.
  *
  * <h4>Solution 2: Custom {@link BSONDecoder} implementation</h4>
- * If you need to customize bytes decoding at the lowest layer you have to provide you own
+ * If you need to customize byte-level decoding at the lowest layer you have to provide you own
  * implementation of the {@link BSONDecoder} interface.
  * <br/>
  * Please check <a href="http://bsonspec.org/">http://bsonspec.org/</a> for more information.
@@ -284,7 +284,7 @@ boolean decodeElement()
      * @throws IOException
      *
      * @deprecated This method should not be a part of API.
-     *             Please see the description of the current class for a migration instructions.
+     *             Please see the class-level documentation for a migration instructions.
      */
     @Deprecated
     protected void _binary( final String name )
@@ -341,7 +341,7 @@ Object _readBasicObject()
 
     /**
      * @deprecated This class should not be a part of API.
-     *             Please see the description of the current class for a migration instructions.
+     *             Please see the class-level documentation for a migration instructions.
      */
     @Deprecated
     protected class BSONInput {
@@ -555,14 +555,14 @@ public void setMax(int _max) {
 
     /**
      * @deprecated This field should not be a part of API.
-     *             Please see the description of the current class for a migration instructions.
+     *             Please see the class-level documentation for a migration instructions.
      */
     @Deprecated
     protected BSONInput _in;
 
     /**
      * @deprecated This field should not be a part of API.
-     *             Please see the description of the current class for a migration instructions.
+     *             Please see the class-level documentation for a migration instructions.
      */
     @Deprecated
     protected BSONCallback _callback;
@@ -574,14 +574,14 @@ public void setMax(int _max) {
 
     /**
      * @deprecated This field should not be a part of API.
-     *             Please see the description of the current class for a migration instructions.
+     *             Please see the class-level documentation for a migration instructions.
      */
     @Deprecated
     protected int _pos; // current offset into _inputBuffer
 
     /**
      * @deprecated This field should not be a part of API.
-     *             Please see the description of the current class for a migration instructions.
+     *             Please see the class-level documentation for a migration instructions.
      */
     @Deprecated
     protected int _len; // length of valid data in _inputBuffer
diff --git a/src/main/org/bson/NewBSONDecoder.java b/src/main/org/bson/NewBSONDecoder.java
@@ -29,7 +29,7 @@
 /**
  * A new implementation of the bson decoder.
  *
- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
 @Deprecated
 public class NewBSONDecoder implements BSONDecoder {
diff --git a/src/main/org/bson/io/BasicOutputBuffer.java b/src/main/org/bson/io/BasicOutputBuffer.java
@@ -47,7 +47,7 @@ public int getPosition(){
     }
 
     /**
-     * @deprecated This method is NOT a part of public API and will be propped in 3.x versions.
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
      */
     @Override
     @Deprecated
@@ -56,7 +56,7 @@ public void setPosition( int position ){
     }
 
     /**
-     * @deprecated This method is NOT a part of public API and will be propped in 3.x versions.
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
      */
     @Override
     @Deprecated
@@ -65,7 +65,7 @@ public void seekEnd(){
     }
 
     /**
-     * @deprecated This method is NOT a part of public API and will be propped in 3.x versions.
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
      */
     @Deprecated
     @Override
@@ -93,7 +93,7 @@ public int pipe( OutputStream out )
 
     /**
      * @return bytes written
-     * @deprecated This method is NOT a part of public API and will be propped in 3.x versions.
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
      */
     @Deprecated
     public int pipe( DataOutput out )
@@ -118,7 +118,7 @@ void _ensure( int more ){
     }
 
     /**
-     * @deprecated This method is NOT a part of public API and will be propped in 3.x versions.
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
      */
     @Override
     @Deprecated
@@ -127,7 +127,7 @@ public String asString(){
     }
 
     /**
-     * @deprecated This method is NOT a part of public API and will be propped in 3.x versions.
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
      */
     @Override
     @Deprecated
diff --git a/src/main/org/bson/io/OutputBuffer.java b/src/main/org/bson/io/OutputBuffer.java
diff --git a/src/main/org/bson/io/PoolOutputBuffer.java b/src/main/org/bson/io/PoolOutputBuffer.java
diff --git a/src/main/org/bson/types/ObjectId.java b/src/main/org/bson/types/ObjectId.java

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@`
`53`	`53`	`* Methods implemented at the port level should throw the raw exceptions like IOException,`
`54`	`54`	`* so that the connector above can make appropriate decisions on how to handle.`
`55`	`55`	`*`
`56`		`- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.`
	`56`	`+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.`
`57`	`57`	`*/`
`58`	`58`	`@Deprecated`
`59`	`59`	`public class DBPort {`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`/**`
`37`	`37`	`* This class is NOT part of the public API. Be prepared for non-binary compatible changes in minor releases.`
`38`	`38`	`*`
`39`		`- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.`
	`39`	`+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.`
`40`	`40`	`*/`
`41`	`41`	`@Deprecated`
`42`	`42`	`public class DBPortPool extends SimplePool<DBPort> {`
Original file line number	Diff line number	Diff line change
`@@ -426,7 +426,7 @@ public String getVersion(){`
`426`	`426`	`* returns a string representing the hosts used in this Mongo instance`
`427`	`427`	`* @return`
`428`	`428`	`*`
`429`		`- * @deprecated This method is NOT a part of public API and will be propped in 3.x versions.`
	`429`	`+ * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.`
`430`	`430`	`*/`
`431`	`431`	`@Deprecated`
`432`	`432`	`public String debugString(){`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@`
`55`	`55`	`/**`
`56`	`56`	`* This object wraps the binary object format ("BSON") used for the transport of serialized objects to / from the Mongo database.`
`57`	`57`	`*`
`58`		`- * @deprecated This class is NOT a part of public API and will be propped in 3.x versions.`
	`58`	`+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.`
`59`	`59`	`*/`
`60`	`60`	`@Deprecated`
`61`	`61`	`public class RawDBObject implements DBObject {`