Review fixes

kocsismate · kocsismate · commit 6f3240854755 · 2024-11-30T10:08:33.000+01:00
diff --git a/language-snippets.ent b/language-snippets.ent
@@ -1823,6 +1823,12 @@ that is typically created using <function>fopen</function>.</para>'>
 <!ENTITY odbc.connection.id '<para xmlns="http://docbook.org/ns/docbook">The ODBC connection object,
 see <function>odbc_connect</function> for details.</para>'>
 
+<!ENTITY odbc.result.object 'The ODBC result object.'>
+
+<!ENTITY odbc.result.object-return 'Returns an ODBC result object'>
+
+<!ENTITY odbc.result.object-return-falseforfailure '&odbc.result.object-return;&return.falseforfailure;.'>
+
 <!ENTITY odbc.parameter.catalog 'The catalog (&apos;qualifier&apos; in ODBC 2 parlance).'>
 
 <!ENTITY odbc.parameter.schema 'The schema (&apos;owner&apos; in ODBC 2 parlance).'>
diff --git a/reference/uodbc/functions/odbc-binmode.xml b/reference/uodbc/functions/odbc-binmode.xml
@@ -92,7 +92,7 @@
      <term><parameter>statement</parameter></term>
      <listitem>
       <para>
-       The result object.
+       &odbc.result.object;
       </para>
       <para>
        If <parameter>statement</parameter> is <literal>0</literal>, the
diff --git a/reference/uodbc/functions/odbc-close.xml b/reference/uodbc/functions/odbc-close.xml
@@ -51,7 +51,7 @@
    </tgroup>
   </informaltable>
  </refsect1>
- 
+
  <refsect1 role="notes">
   &reftitle.notes;
   <note>
diff --git a/reference/uodbc/functions/odbc-columnprivileges.xml b/reference/uodbc/functions/odbc-columnprivileges.xml
@@ -70,7 +70,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object&return.falseforfailure;.
+   &odbc.result.object-return-falseforfailure;
    This result object can be used to fetch a list of columns and
    associated privileges.
   </para>
diff --git a/reference/uodbc/functions/odbc-columns.xml b/reference/uodbc/functions/odbc-columns.xml
@@ -70,7 +70,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object&return.falseforfailure;.
+   &odbc.result.object-return-falseforfailure;
   </para>
   <para>
    The result set has the following columns:
diff --git a/reference/uodbc/functions/odbc-error.xml b/reference/uodbc/functions/odbc-error.xml
@@ -57,7 +57,7 @@
      <row>
       <entry>8.0.0</entry>
       <entry>
-       <parameter>odbc</parameter> is nullable now.
+       <parameter>odbc</parameter> is now nullable.
       </entry>
      </row>
     </tbody>
diff --git a/reference/uodbc/functions/odbc-errormsg.xml b/reference/uodbc/functions/odbc-errormsg.xml
@@ -57,7 +57,7 @@
      <row>
       <entry>8.0.0</entry>
       <entry>
-       <parameter>odbc</parameter> is nullable now.
+       <parameter>odbc</parameter> is now nullable.
       </entry>
      </row>
     </tbody>
diff --git a/reference/uodbc/functions/odbc-exec.xml b/reference/uodbc/functions/odbc-exec.xml
@@ -40,7 +40,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object if the SQL command was executed
+   &odbc.result.object-return; if the SQL command was executed
    successfully, or &false; on error.
   </para>
  </refsect1>
diff --git a/reference/uodbc/functions/odbc-fetch-array.xml b/reference/uodbc/functions/odbc-fetch-array.xml
@@ -26,7 +26,7 @@
      <term><parameter>statement</parameter></term>
      <listitem>
       <para>
-       The result object from <function>odbc_exec</function>.
+       &odbc.result.object; from <function>odbc_exec</function>.
       </para>
      </listitem>
     </varlistentry>
@@ -65,7 +65,7 @@
      <row>
       <entry>8.4.0</entry>
       <entry>
-       <parameter>row</parameter> is nullable now.
+       <parameter>row</parameter> is now nullable.
       </entry>
      </row>
     </tbody>
diff --git a/reference/uodbc/functions/odbc-fetch-into.xml b/reference/uodbc/functions/odbc-fetch-into.xml
@@ -27,7 +27,7 @@
      <term><parameter>statement</parameter></term>
      <listitem>
       <para>
-       The result object.
+       &odbc.result.object;.
       </para>
      </listitem>
     </varlistentry>
@@ -77,7 +77,7 @@
      <row>
       <entry>8.4.0</entry>
       <entry>
-       <parameter>row</parameter> is nullable now.
+       <parameter>row</parameter> is now nullable.
       </entry>
      </row>
     </tbody>
diff --git a/reference/uodbc/functions/odbc-fetch-object.xml b/reference/uodbc/functions/odbc-fetch-object.xml
@@ -65,7 +65,7 @@
      <row>
       <entry>8.4.0</entry>
       <entry>
-       <parameter>row</parameter> is nullable now.
+       <parameter>row</parameter> is now nullable.
       </entry>
      </row>
     </tbody>
diff --git a/reference/uodbc/functions/odbc-fetch-row.xml b/reference/uodbc/functions/odbc-fetch-row.xml
@@ -76,7 +76,7 @@
      <row>
       <entry>8.0.0</entry>
       <entry>
-       <parameter>row</parameter> is nullable now.
+       <parameter>row</parameter> is now nullable.
       </entry>
      </row>
     </tbody>
diff --git a/reference/uodbc/functions/odbc-field-len.xml b/reference/uodbc/functions/odbc-field-len.xml
@@ -63,6 +63,7 @@
    </tgroup>
   </informaltable>
  </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
diff --git a/reference/uodbc/functions/odbc-foreignkeys.xml b/reference/uodbc/functions/odbc-foreignkeys.xml
@@ -90,7 +90,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object&return.falseforfailure;.
+   &odbc.result.object-return-falseforfailure;
   </para>
   <para>
    The result set has the following columns:
diff --git a/reference/uodbc/functions/odbc-free-result.xml b/reference/uodbc/functions/odbc-free-result.xml
@@ -58,7 +58,7 @@
    </tgroup>
   </informaltable>
  </refsect1>
- 
+
  <refsect1 role="notes">
   &reftitle.notes;
   <note>
diff --git a/reference/uodbc/functions/odbc-gettypeinfo.xml b/reference/uodbc/functions/odbc-gettypeinfo.xml
@@ -44,8 +44,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object or
-   &false; on failure.
+   &odbc.result.object-return-falseforfailure;
   </para>
   <para>
    The result set has the following columns:
diff --git a/reference/uodbc/functions/odbc-num-rows.xml b/reference/uodbc/functions/odbc-num-rows.xml
@@ -40,6 +40,7 @@
    This function will return -1 on error.
   </para>
  </refsect1>
+
  <refsect1 role="changelog">
   &reftitle.changelog;
   <informaltable>
@@ -56,6 +57,7 @@
    </tgroup>
   </informaltable>
  </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   <note>
diff --git a/reference/uodbc/functions/odbc-prepare.xml b/reference/uodbc/functions/odbc-prepare.xml
@@ -50,7 +50,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object if the SQL command was prepared
+   &odbc.result.object-return; if the SQL command was prepared
    successfully. Returns &false; on error.
   </para>
  </refsect1>
diff --git a/reference/uodbc/functions/odbc-primarykeys.xml b/reference/uodbc/functions/odbc-primarykeys.xml
@@ -58,7 +58,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object&return.falseforfailure;.
+   &odbc.result.object-return-falseforfailure;
   </para>
   <para>
    The result set has the following columns:
diff --git a/reference/uodbc/functions/odbc-procedurecolumns.xml b/reference/uodbc/functions/odbc-procedurecolumns.xml
@@ -75,7 +75,7 @@
   <para>
    Returns the list of input and output parameters, as well as the
    columns that make up the result set for the specified procedures. 
-   Returns an ODBC result object&return.falseforfailure;.
+   &odbc.result.object-return-falseforfailure;
   </para>
   <para>
    The result set has the following columns:
diff --git a/reference/uodbc/functions/odbc-setoption.xml b/reference/uodbc/functions/odbc-setoption.xml
@@ -111,7 +111,7 @@
    </tgroup>
   </informaltable>
  </refsect1>
- 
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
diff --git a/reference/uodbc/functions/odbc-specialcolumns.xml b/reference/uodbc/functions/odbc-specialcolumns.xml
@@ -101,8 +101,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object or &false; on
-   failure.
+   &odbc.result.object-return-falseforfailure;
   </para>
   <para>
    The result set has the following columns:
diff --git a/reference/uodbc/functions/odbc-statistics.xml b/reference/uodbc/functions/odbc-statistics.xml
@@ -82,7 +82,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object&return.falseforfailure;.
+   &odbc.result.object-return-falseforfailure;
   </para>
   <para>
    The result set has the following columns:
diff --git a/reference/uodbc/functions/odbc-tableprivileges.xml b/reference/uodbc/functions/odbc-tableprivileges.xml
@@ -64,7 +64,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   An ODBC result object&return.falseforfailure;.
+   &odbc.result.object-return-falseforfailure;
   </para>
   <para>
    The result set has the following columns:
diff --git a/reference/uodbc/functions/odbc-tables.xml b/reference/uodbc/functions/odbc-tables.xml
@@ -117,7 +117,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an ODBC result object containing the information 
+   &odbc.result.object-return; containing the information
    &return.falseforfailure;.
   </para>
   <para>
diff --git a/reference/uodbc/setup.xml b/reference/uodbc/setup.xml
@@ -26,7 +26,7 @@
  <section xml:id="uodbc.resources">
   &reftitle.resources;
   <para>
-   This extension defines two resource types: an ODBC connection identifier
+   This extension defined two resource types until PHP 8.4: an ODBC connection identifier
    and an ODBC result identifier.
   </para>
  </section>
