From d3d74d26a27b69ef3eeabeb1e4032fefcb30d5aa Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Wed, 2 May 2018 23:05:35 +0000
Subject: [PATCH] Fixes and clarifications; sorry for mixing in whitespace
 changes but this shouldn't be translated yet

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344929 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../mysql_xdevapi/collection/getschema.xml    | 18 ++++++++++++-
 .../mysql_xdevapi/collection/getsession.xml   | 16 +++++++++++
 .../mysql_xdevapi/collectionfind/execute.xml  |  8 +++---
 .../collectionmodify/replace.xml              |  4 +--
 .../mysql_xdevapi/collectionmodify/unset.xml  |  8 +++---
 .../mysql_xdevapi/schema/dropcollection.xml   | 13 ++-------
 .../mysql_xdevapi/schema/getsession.xml       |  4 +--
 .../session/releasesavepoint.xml              |  8 +++---
 .../mysql_xdevapi/session/rollbackto.xml      |  8 +++---
 .../mysql_xdevapi/table/select.xml            | 27 ++++++++++++++++---
 10 files changed, 78 insertions(+), 36 deletions(-)

diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml
index b0ef217fbe..f729864a3d 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml
@@ -27,11 +27,27 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   The schema object on success, or &null; if the object cannot be retrieved 
+   The schema object on success, or &null; if the object cannot be retrieved
    for the given collection.
   </para>
  </refsect1>
 
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>mysql_xdevapi\Collection::getSchema</function> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+
+$schema = $collection->getSchema();
+
+?>
+]]>
+   </programlisting>
+  </example>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml
index 34dffd2a59..0474903a6b 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml
@@ -31,6 +31,22 @@
   </para>
  </refsect1>
 
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>mysql_xdevapi\Collection::getSession</function> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+
+$session = $coll->getSession();
+
+?>
+]]>
+   </programlisting>
+  </example>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml
index 27e68bd043..510b5ad570 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>mysql_xdevapi\Result</type><methodname>mysql_xdevapi\CollectionFind::execute</methodname>
+   <modifier>public</modifier> <type>mysql_xdevapi\DocResult</type><methodname>mysql_xdevapi\CollectionFind::execute</methodname>
    <void />
   </methodsynopsis>
   <para>
@@ -28,7 +28,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   A Result object that can be used to query the status of the operation 
+   A DocResult object that can be used to query the status of the operation
   </para>
  </refsect1>
 
@@ -48,8 +48,8 @@ $res = $coll->find('name IN ("Marco","Lucio")')->execute();
 
 ?>
 ]]>
-   </programlisting>
-  </example>
+   </programlisting>
+  </example>
  </refsect1>
 
 
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml
index 8af20ca7fc..0e9caa063d 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml
@@ -12,10 +12,10 @@
   <methodsynopsis>
    <modifier>public</modifier> <type>mysql_xdevapi\CollectionModify</type><methodname>mysql_xdevapi\CollectionModify::replace</methodname>
    <methodparam><type>string</type><parameter>collection_field</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>expression_or_literal</parameter></methodparam>
+   <methodparam><type>string</type><parameter>expression_or_literal</parameter></methodparam>
   </methodsynopsis>
   <para>
-    Replace (update) a given field value with a new one. 
+    Replace (update) a given field value with a new one.
   </para>
 
   &warn.undocumented.func;
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml
index 0406d48be0..eded68c09a 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml
@@ -11,7 +11,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>mysql_xdevapi\CollectionModify</type><methodname>mysql_xdevapi\CollectionModify::unset</methodname>
-   <methodparam><type>array</type><parameter>variables</parameter></methodparam>
+   <methodparam><type>array</type><parameter>fields</parameter></methodparam>
   </methodsynopsis>
   <para>
 	  Removes attributes from documents in a collection.
@@ -25,7 +25,7 @@
   &reftitle.parameters;
   <variablelist>
    <varlistentry>
-    <term><parameter>variables</parameter></term>
+    <term><parameter>fields</parameter></term>
     <listitem>
      <para>
 		 The attributes to remove from documents in a collection.
@@ -54,8 +54,8 @@ $res = $coll->modify('job like :job_name')->unset(["age", "name"])->bind(['job_n
 
 ?>
 ]]>
-   </programlisting>
-  </example>
+   </programlisting>
+  </example>
  </refsect1>
 
 
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml
index b0a1c4fe99..5a18f1982f 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml
@@ -11,7 +11,6 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>bool</type><methodname>mysql_xdevapi\Schema::dropCollection</methodname>
-   <methodparam><type>string</type><parameter>schema_name</parameter></methodparam>
    <methodparam><type>string</type><parameter>collection_name</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -25,19 +24,11 @@
  <refsect1 role="parameters">
   &reftitle.parameters;
   <variablelist>
-   <varlistentry>
-    <term><parameter>schema_name</parameter></term>
-    <listitem>
-     <para>
-      
-     </para>
-    </listitem>
-   </varlistentry>
    <varlistentry>
     <term><parameter>collection_name</parameter></term>
     <listitem>
      <para>
-      
+
      </para>
     </listitem>
    </varlistentry>
@@ -47,7 +38,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+
   </para>
  </refsect1>
 
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml
index 592a37b87c..782f25c162 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml
@@ -29,7 +29,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+
   </para>
  </refsect1>
 
@@ -41,7 +41,7 @@
 <![CDATA[
 <?php
 
-/* ... */
+$session = $schema->getSession();
 
 ?>
 ]]>
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml
index 78c3b4a195..db37fcf54f 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml
@@ -11,12 +11,12 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>mysql_xdevapi\Session::releaseSavepoint</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
+   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   </methodsynopsis>
   <para>
    Release a previously set savepoint.
   </para>
-  
+
   &warn.undocumented.func;
 
  </refsect1>
@@ -28,7 +28,7 @@
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
-      
+
      </para>
     </listitem>
    </varlistentry>
@@ -38,7 +38,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+
   </para>
  </refsect1>
 
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml
index 9b9e462dba..26998b1cdd 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml
@@ -11,12 +11,12 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>mysql_xdevapi\Session::rollbackTo</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
+   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   </methodsynopsis>
   <para>
    Rollback the transaction back to the savepoint.
   </para>
-  
+
   &warn.undocumented.func;
 
  </refsect1>
@@ -28,7 +28,7 @@
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
-      
+
      </para>
     </listitem>
    </varlistentry>
@@ -38,7 +38,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+
   </para>
  </refsect1>
 
diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml
index 7ad5272707..b7c05322c3 100644
--- a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml
+++ b/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml
@@ -11,7 +11,8 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>mysql_xdevapi\TableSelect</type><methodname>mysql_xdevapi\Table::select</methodname>
-   <void />
+   <methodparam><type>mixed</type><parameter>columns</parameter></methodparam>
+   <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
   </methodsynopsis>
   <para>
 	Creates a new TableSelect object.
@@ -21,7 +22,25 @@
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  &no.function.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>columns</parameter></term>
+    <listitem>
+     <para>
+      The columns to select data from. Can be an array
+      with one or more values, or a string.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>...</parameter></term>
+    <listitem>
+     <para>
+      Additional columns parameter definitions.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
  </refsect1>
 
  <refsect1 role="returnvalues">
@@ -43,8 +62,8 @@ $res = $table->select(['age', 'name'])->execute();
 
 ?>
 ]]>
-   </programlisting>
-  </example>
+   </programlisting>
+  </example>
  </refsect1>