Merge pull request #423 from kvwalker/PHPLIB-284

kvwalker · web-flow · commit f96124f266a9 · 2017-10-25T16:04:38.000-04:00
PHPLIB-284 Highlight API changes in documentation
diff --git a/docs/includes/apiargs-MongoDBCollection-method-find-option.yaml b/docs/includes/apiargs-MongoDBCollection-method-find-option.yaml
@@ -100,9 +100,18 @@ interface: phpmethod
 operation: ~
 optional: true
 ---
-source:
-  file: apiargs-common-option.yaml
-  ref: maxAwaitTimeMS
+arg_name: option
+name: maxAwaitTimeMS
+type: integer
+description: |
+  Positive integer denoting the time limit in milliseconds for the server to
+  block a getMore operation if no data is available. This option should only be
+  used if cursorType is TAILABLE_AWAIT.
+
+  .. versionadded:: 1.2
+interface: phpmethod
+operation: ~
+optional: true
 ---
 source:
   file: apiargs-common-option.yaml
diff --git a/docs/includes/apiargs-common-option.yaml b/docs/includes/apiargs-common-option.yaml
@@ -10,17 +10,6 @@ operation: ~
 optional: true
 ---
 arg_name: option
-name: maxAwaitTimeMS
-type: integer
-description: |
-    Positive integer denoting the time limit in milliseconds for the server to block
-    a getMore operation if no data is available. This option should only be used if
-    cursorType is TAILABLE_AWAIT.
-interface: phpmethod
-operation: ~
-optional: true
----
-arg_name: option
 name: readConcern
 type: :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
 description: |
diff --git a/docs/reference/method/MongoDBClient-getReadConcern.txt b/docs/reference/method/MongoDBClient-getReadConcern.txt
@@ -2,6 +2,8 @@
 MongoDB\\Client::getReadConcern()
 =================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBClient-getReadPreference.txt b/docs/reference/method/MongoDBClient-getReadPreference.txt
@@ -2,6 +2,8 @@
 MongoDB\\Client::getReadPreference()
 ====================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBClient-getTypeMap.txt b/docs/reference/method/MongoDBClient-getTypeMap.txt
@@ -2,6 +2,8 @@
 MongoDB\\Client::getTypeMap()
 =============================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBClient-getWriteConcern.txt b/docs/reference/method/MongoDBClient-getWriteConcern.txt
@@ -2,6 +2,8 @@
 MongoDB\\Client::getWriteConcern()
 ==================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBCollection-getReadConcern.txt b/docs/reference/method/MongoDBCollection-getReadConcern.txt
@@ -2,6 +2,8 @@
 MongoDB\\Collection::getReadConcern()
 =====================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBCollection-getReadPreference.txt b/docs/reference/method/MongoDBCollection-getReadPreference.txt
@@ -2,6 +2,8 @@
 MongoDB\\Collection::getReadPreference()
 ========================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBCollection-getTypeMap.txt b/docs/reference/method/MongoDBCollection-getTypeMap.txt
@@ -2,6 +2,8 @@
 MongoDB\\Collection::getTypeMap()
 =================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBCollection-getWriteConcern.txt b/docs/reference/method/MongoDBCollection-getWriteConcern.txt
@@ -2,6 +2,8 @@
 MongoDB\\Collection::getWriteConcern()
 ======================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBCollection-mapReduce.txt b/docs/reference/method/MongoDBCollection-mapReduce.txt
@@ -2,6 +2,8 @@
 MongoDB\\Collection::mapReduce()
 =================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBDatabase-getReadConcern.txt b/docs/reference/method/MongoDBDatabase-getReadConcern.txt
@@ -2,6 +2,8 @@
 MongoDB\\Database::getReadConcern()
 ===================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBDatabase-getReadPreference.txt b/docs/reference/method/MongoDBDatabase-getReadPreference.txt
@@ -2,6 +2,8 @@
 MongoDB\\Database::getReadPreference()
 ======================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBDatabase-getTypeMap.txt b/docs/reference/method/MongoDBDatabase-getTypeMap.txt
@@ -2,6 +2,8 @@
 MongoDB\\Database::getTypeMap()
 ===============================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBDatabase-getWriteConcern.txt b/docs/reference/method/MongoDBDatabase-getWriteConcern.txt
@@ -2,6 +2,8 @@
 MongoDB\\Database::getWriteConcern()
 ====================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBGridFSBucket-getChunkSizeBytes.txt b/docs/reference/method/MongoDBGridFSBucket-getChunkSizeBytes.txt
@@ -2,6 +2,8 @@
 MongoDB\\GridFS\\Bucket::getChunkSizeBytes()
 ============================================
 
+.. versionchanged:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBGridFSBucket-getChunksCollection.txt b/docs/reference/method/MongoDBGridFSBucket-getChunksCollection.txt
@@ -2,6 +2,8 @@
 MongoDB\\GridFS\\Bucket::getChunksCollection()
 ==============================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBGridFSBucket-getFilesCollection.txt b/docs/reference/method/MongoDBGridFSBucket-getFilesCollection.txt
@@ -2,6 +2,8 @@
 MongoDB\\GridFS\\Bucket::getFilesCollection()
 =============================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt b/docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt
@@ -2,6 +2,8 @@
 MongoDB\\GridFS\\Bucket::getReadConcern()
 =========================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt b/docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt
@@ -2,6 +2,8 @@
 MongoDB\\GridFS\\Bucket::getReadPreference()
 ============================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt b/docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt
@@ -2,6 +2,8 @@
 MongoDB\\GridFS\\Bucket::getTypeMap()
 =====================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
diff --git a/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt b/docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt
@@ -2,6 +2,8 @@
 MongoDB\\GridFS\Bucket::getWriteConcern()
 =========================================
 
+.. versionadded:: 1.2
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
