Skip to content

Commit 7e5d0d1

Browse files
kocsismatecmb69
kocsismate
authored and
cmb69
committed
Generate mysqli methodsynopses based on stubs
Cf. <#301>.
1 parent 661e99f commit 7e5d0d1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+500
-490
lines changed

‎reference/mysqli/mysqli/affected-rows.xml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
<refsect1 role="description">
1111
&reftitle.description;
1212
<para>&style.oop;</para>
13-
<fieldsynopsis><type>int</type><varname linkend="mysqli.affected-rows">mysqli->affected_rows</varname></fieldsynopsis>
13+
<fieldsynopsis><type>int</type><varname linkend="mysqli.affected-rows">mysqli-&gt;affected_rows</varname></fieldsynopsis>
1414
<para>&style.procedural;</para>
1515
<methodsynopsis>
16-
<type>int</type><methodname>mysqli_affected_rows</methodname>
17-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
16+
<type class="union"><type>int</type><type>string</type></type><methodname>mysqli_affected_rows</methodname>
17+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
1818
</methodsynopsis>
1919
<para>
2020
Returns the number of rows affected by the last <literal>INSERT</literal>,
@@ -57,7 +57,7 @@
5757
<refsect1 role="examples">
5858
&reftitle.examples;
5959
<example>
60-
<title><varname>$mysqli->affected_rows</varname> example</title>
60+
<title><varname>$mysqli-&gt;affected_rows</varname> example</title>
6161
<para>&style.oop;</para>
6262
<programlisting role="php">
6363
<![CDATA[
@@ -160,7 +160,6 @@ Affected rows (SELECT): 169
160160
</refsect1>
161161

162162
</refentry>
163-
164163
<!-- Keep this comment at the end of the file
165164
Local variables:
166165
mode: sgml

‎reference/mysqli/mysqli/autocommit.xml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@
1212
<para>&style.oop;</para>
1313
<methodsynopsis role="oop">
1414
<modifier>public</modifier> <type>bool</type><methodname>mysqli::autocommit</methodname>
15-
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
15+
<methodparam><type>bool</type><parameter>enable</parameter></methodparam>
1616
</methodsynopsis>
1717
<para>&style.procedural;</para>
18-
<methodsynopsis>
18+
<methodsynopsis role="procedural">
1919
<type>bool</type><methodname>mysqli_autocommit</methodname>
20-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
21-
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
20+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
21+
<methodparam><type>bool</type><parameter>enable</parameter></methodparam>
2222
</methodsynopsis>
2323
<para>
2424
Turns on or off auto-commit mode on queries for the database connection.
@@ -35,7 +35,7 @@
3535
<variablelist>
3636
&mysqli.link.description;
3737
<varlistentry>
38-
<term><parameter>mode</parameter></term>
38+
<term><parameter>enable</parameter></term>
3939
<listitem>
4040
<para>
4141
Whether to turn on auto-commit or not.
@@ -221,7 +221,6 @@ Committed 2 row in the database
221221
</refsect1>
222222

223223
</refentry>
224-
225224
<!-- Keep this comment at the end of the file
226225
Local variables:
227226
mode: sgml

‎reference/mysqli/mysqli/begin-transaction.xml

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
43
<refentry xml:id="mysqli.begin-transaction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
54
<refnamediv>
65
<refname>mysqli::begin_transaction</refname>
@@ -14,14 +13,14 @@
1413
<methodsynopsis role="oop">
1514
<modifier>public</modifier> <type>bool</type><methodname>mysqli::begin_transaction</methodname>
1615
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
17-
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
16+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
1817
</methodsynopsis>
1918
<para>&style.procedural;:</para>
20-
<methodsynopsis>
19+
<methodsynopsis role="procedural">
2120
<type>bool</type><methodname>mysqli_begin_transaction</methodname>
22-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
21+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
2322
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
24-
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
23+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
2524
</methodsynopsis>
2625
<para>
2726
Begins a transaction. Requires the InnoDB
@@ -94,6 +93,28 @@
9493
</note>
9594
</refsect1>
9695

96+
<refsect1 role="changelog">
97+
&reftitle.changelog;
98+
<informaltable>
99+
<tgroup cols="2">
100+
<thead>
101+
<row>
102+
<entry>&Version;</entry>
103+
<entry>&Description;</entry>
104+
</row>
105+
</thead>
106+
<tbody>
107+
<row>
108+
<entry>8.0.0</entry>
109+
<entry>
110+
<parameter>name</parameter> is now nullable.
111+
</entry>
112+
</row>
113+
</tbody>
114+
</tgroup>
115+
</informaltable>
116+
</refsect1>
117+
97118
<refsect1 role="examples">
98119
&reftitle.examples;
99120
<example xml:id="mysqli.begin-transaction.example.basic">
@@ -191,7 +212,6 @@ try {
191212
</refsect1>
192213

193214
</refentry>
194-
195215
<!-- Keep this comment at the end of the file
196216
Local variables:
197217
mode: sgml

‎reference/mysqli/mysqli/change-user.xml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@
1212
<para>&style.oop;</para>
1313
<methodsynopsis role="oop">
1414
<modifier>public</modifier> <type>bool</type><methodname>mysqli::change_user</methodname>
15-
<methodparam><type>string</type><parameter>user</parameter></methodparam>
15+
<methodparam><type>string</type><parameter>username</parameter></methodparam>
1616
<methodparam><type>string</type><parameter>password</parameter></methodparam>
17-
<methodparam><type>string</type><parameter>database</parameter></methodparam>
17+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>database</parameter></methodparam>
1818
</methodsynopsis>
1919
<para>&style.procedural;</para>
20-
<methodsynopsis>
20+
<methodsynopsis role="procedural">
2121
<type>bool</type><methodname>mysqli_change_user</methodname>
22-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
23-
<methodparam><type>string</type><parameter>user</parameter></methodparam>
22+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
23+
<methodparam><type>string</type><parameter>username</parameter></methodparam>
2424
<methodparam><type>string</type><parameter>password</parameter></methodparam>
25-
<methodparam><type>string</type><parameter>database</parameter></methodparam>
25+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>database</parameter></methodparam>
2626
</methodsynopsis>
2727
<para>
2828
Changes the user of the specified database connection and sets the current
@@ -42,7 +42,7 @@
4242
<variablelist>
4343
&mysqli.link.description;
4444
<varlistentry>
45-
<term><parameter>user</parameter></term>
45+
<term><parameter>username</parameter></term>
4646
<listitem>
4747
<para>
4848
The MySQL user name.
@@ -196,7 +196,6 @@ Value of variable a is NULL
196196
</refsect1>
197197

198198
</refentry>
199-
200199
<!-- Keep this comment at the end of the file
201200
Local variables:
202201
mode: sgml

‎reference/mysqli/mysqli/character-set-name.xml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
<para>&style.oop;</para>
1313
<methodsynopsis role="oop">
1414
<modifier>public</modifier> <type>string</type><methodname>mysqli::character_set_name</methodname>
15-
<void />
15+
<void/>
1616
</methodsynopsis>
1717
<para>&style.procedural;</para>
18-
<methodsynopsis>
18+
<methodsynopsis role="procedural">
1919
<type>string</type><methodname>mysqli_character_set_name</methodname>
20-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
20+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
2121
</methodsynopsis>
2222
<para>
2323
Returns the current character set for the database connection.
@@ -106,7 +106,6 @@ Current character set is latin1_swedish_ci
106106
</refsect1>
107107

108108
</refentry>
109-
110109
<!-- Keep this comment at the end of the file
111110
Local variables:
112111
mode: sgml

‎reference/mysqli/mysqli/close.xml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
<para>&style.oop;</para>
1313
<methodsynopsis role="oop">
1414
<modifier>public</modifier> <type>bool</type><methodname>mysqli::close</methodname>
15-
<void />
15+
<void/>
1616
</methodsynopsis>
1717
<para>&style.procedural;</para>
18-
<methodsynopsis>
18+
<methodsynopsis role="procedural">
1919
<type>bool</type><methodname>mysqli_close</methodname>
20-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
20+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
2121
</methodsynopsis>
2222
<para>
2323
Closes a previously opened database connection.
@@ -72,7 +72,6 @@
7272
</refsect1>
7373

7474
</refentry>
75-
7675
<!-- Keep this comment at the end of the file
7776
Local variables:
7877
mode: sgml

‎reference/mysqli/mysqli/commit.xml

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@
1313
<methodsynopsis role="oop">
1414
<modifier>public</modifier> <type>bool</type><methodname>mysqli::commit</methodname>
1515
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
16-
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
16+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
1717
</methodsynopsis>
1818
<para>&style.procedural;</para>
19-
<methodsynopsis>
19+
<methodsynopsis role="procedural">
2020
<type>bool</type><methodname>mysqli_commit</methodname>
21-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
21+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
2222
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
23-
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
23+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
2424
</methodsynopsis>
2525
<para>
2626
Commits the current transaction for the database connection.
@@ -69,6 +69,30 @@
6969
</note>
7070
</refsect1>
7171

72+
<refsect1 role="changelog">
73+
&reftitle.changelog;
74+
<para>
75+
<informaltable>
76+
<tgroup cols="2">
77+
<thead>
78+
<row>
79+
<entry>&Version;</entry>
80+
<entry>&Description;</entry>
81+
</row>
82+
</thead>
83+
<tbody>
84+
<row>
85+
<entry>8.0.0</entry>
86+
<entry>
87+
<parameter>name</parameter> is now nullable.
88+
</entry>
89+
</row>
90+
</tbody>
91+
</tgroup>
92+
</informaltable>
93+
</para>
94+
</refsect1>
95+
7296
<refsect1 role="examples">
7397
&reftitle.examples;
7498
<para>
@@ -89,7 +113,6 @@
89113
</refsect1>
90114

91115
</refentry>
92-
93116
<!-- Keep this comment at the end of the file
94117
Local variables:
95118
mode: sgml

‎reference/mysqli/mysqli/connect-error.xml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
<refsect1 role="description">
1111
&reftitle.description;
1212
<para>&style.oop;</para>
13-
<fieldsynopsis><modifier>static</modifier> <type>string</type><varname linkend="mysqli.connect-error">mysqli->connect_error</varname></fieldsynopsis>
13+
<fieldsynopsis><modifier>static</modifier> <type class="union"><type>string</type><type>null</type></type><varname linkend="mysqli.connect-error">mysqli-&gt;connect_error</varname></fieldsynopsis>
1414
<para>&style.procedural;</para>
1515
<methodsynopsis>
16-
<type>string</type><methodname>mysqli_connect_error</methodname>
17-
<void />
16+
<type class="union"><type>string</type><type>null</type></type><methodname>mysqli_connect_error</methodname>
17+
<void/>
1818
</methodsynopsis>
1919
<para>
2020
Returns the last error message string from the last call to
@@ -32,7 +32,7 @@
3232
<refsect1 role="examples">
3333
&reftitle.examples;
3434
<example>
35-
<title><varname>$mysqli->connect_error</varname> example</title>
35+
<title><varname>$mysqli-&gt;connect_error</varname> example</title>
3636
<para>&style.oop;</para>
3737
<programlisting role="php">
3838
<![CDATA[
@@ -80,7 +80,6 @@ Connect Error: Access denied for user 'fake_user'@'localhost' (using password: Y
8080
</refsect1>
8181

8282
</refentry>
83-
8483
<!-- Keep this comment at the end of the file
8584
Local variables:
8685
mode: sgml

‎reference/mysqli/mysqli/debug.xml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
<para>&style.oop;</para>
1313
<methodsynopsis role="oop">
1414
<modifier>public</modifier> <type>bool</type><methodname>mysqli::debug</methodname>
15-
<methodparam><type>string</type><parameter>message</parameter></methodparam>
15+
<methodparam><type>string</type><parameter>options</parameter></methodparam>
1616
</methodsynopsis>
1717
<para>&style.procedural;</para>
18-
<methodsynopsis>
18+
<methodsynopsis role="procedural">
1919
<type>bool</type><methodname>mysqli_debug</methodname>
20-
<methodparam><type>string</type><parameter>message</parameter></methodparam>
20+
<methodparam><type>string</type><parameter>options</parameter></methodparam>
2121
</methodsynopsis>
2222
<para>
2323
Performs debugging operations using the Fred Fish debugging library.
@@ -29,7 +29,7 @@
2929
<para>
3030
<variablelist>
3131
<varlistentry>
32-
<term><parameter>message</parameter></term>
32+
<term><parameter>options</parameter></term>
3333
<listitem>
3434
<para>
3535
A string representing the debugging operation to perform
@@ -87,7 +87,6 @@ mysqli_debug("d:t:o,/tmp/client.trace");
8787
</refsect1>
8888

8989
</refentry>
90-
9190
<!-- Keep this comment at the end of the file
9291
Local variables:
9392
mode: sgml

‎reference/mysqli/mysqli/dump-debug-info.xml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
<void/>
1616
</methodsynopsis>
1717
<para>&style.procedural;</para>
18-
<methodsynopsis>
18+
<methodsynopsis role="procedural">
1919
<type>bool</type><methodname>mysqli_dump_debug_info</methodname>
20-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
20+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
2121
</methodsynopsis>
2222
<para>
2323
This function is designed to be executed by an user with the SUPER
@@ -52,7 +52,6 @@
5252
</refsect1>
5353

5454
</refentry>
55-
5655
<!-- Keep this comment at the end of the file
5756
Local variables:
5857
mode: sgml

‎reference/mysqli/mysqli/errno.xml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
<refsect1 role="description">
1111
&reftitle.description;
1212
<para>&style.oop;</para>
13-
<fieldsynopsis><type>int</type><varname linkend="mysqli.errno">mysqli->errno</varname></fieldsynopsis>
13+
<fieldsynopsis><type>int</type><varname linkend="mysqli.errno">mysqli-&gt;errno</varname></fieldsynopsis>
1414
<para>&style.procedural;</para>
1515
<methodsynopsis>
1616
<type>int</type><methodname>mysqli_errno</methodname>
17-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
17+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
1818
</methodsynopsis>
1919
<para>
2020
Returns the last error code for the most recent MySQLi function call that
@@ -50,7 +50,7 @@
5050
<refsect1 role="examples">
5151
&reftitle.examples;
5252
<example>
53-
<title><varname>$mysqli->errno</varname> example</title>
53+
<title><varname>$mysqli-&gt;errno</varname> example</title>
5454
<para>&style.oop;</para>
5555
<programlisting role="php">
5656
<![CDATA[
@@ -115,7 +115,6 @@ Errorcode: 1193
115115
</refsect1>
116116

117117
</refentry>
118-
119118
<!-- Keep this comment at the end of the file
120119
Local variables:
121120
mode: sgml

0 commit comments

Comments
 (0)