Skip to content

Commit 593ea51

Browse files
kocsismatecmb69
kocsismate
authored and
cmb69
committed
Generate ext/gd methodsynopses based on stubs
Co-authored-by: Christoph M. Becker <[email protected]> Closes GH-623.
1 parent dcd6496 commit 593ea51

File tree

104 files changed

+2205
-515
lines changed

Some content is hidden

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

104 files changed

+2205
-515
lines changed

‎language-snippets.ent

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,7 @@ PHP is compiled with freetype support (<option role="configure">--with-freetype-
709709
<!ENTITY note.gd.interpolation '<note xmlns="http://docbook.org/ns/docbook"><para>This function is affected by the interpolation method set by <function>imagesetinterpolation</function>.</para></note>'>
710710

711711
<!ENTITY gd.image.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
712-
image</parameter></term><listitem><para>An image resource, returned by one of the image creation functions,
712+
image</parameter></term><listitem><para>A <classname>GdImage</classname> object, returned by one of the image creation functions,
713713
such as <function>imagecreatetruecolor</function>.</para></listitem></varlistentry>'>
714714

715715
<!ENTITY gd.font.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
@@ -768,7 +768,7 @@ $font = 'SomeFont';
768768
</varlistentry>
769769
">
770770

771-
<!ENTITY gd.return.identifier 'Returns an image resource identifier on success, &false; on errors.'>
771+
<!ENTITY gd.return.identifier 'Returns an image object on success, &false; on errors.'>
772772

773773
<!ENTITY gd.return.trueonerror '<caution xmlns="http://docbook.org/ns/docbook"><simpara>However, if libgd fails to output the image, this function returns &true;.</simpara></caution>'>
774774

@@ -854,6 +854,14 @@ and GD2 image formats are proprietary image formats of libgd. They have to be re
854854
<emphasis>obsolete</emphasis>, and should only be used for development and testing
855855
purposes.</simpara></warning>'>
856856

857+
<!ENTITY gd.changelog.image-param '<row xmlns="http://docbook.org/ns/docbook">
858+
<entry>8.0.0</entry>
859+
<entry>
860+
<parameter>image</parameter> expects a <classname>GdImage</classname>
861+
instance now; previously, a <type>resource</type> was expected.
862+
</entry>
863+
</row>'>
864+
857865
<!-- DBM notes -->
858866

859867
<!ENTITY dbm.dbm-identifier.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>

‎reference/image/functions/image2wbmp.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,15 @@
2727
&reftitle.parameters;
2828
<para>
2929
<variablelist>
30-
&gd.image.description;
30+
<varlistentry>
31+
<term><parameter>image</parameter></term>
32+
<listitem>
33+
<para>
34+
An image resource, returned by one of the image creation functions,
35+
such as <function>imagecreatetruecolor</function>.
36+
</para>
37+
</listitem>
38+
</varlistentry>
3139
<varlistentry>
3240
<term><parameter>filename</parameter></term>
3341
<listitem>

‎reference/image/functions/imageaffine.xml

Lines changed: 34 additions & 7 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="function.imageaffine" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
54
<refnamediv>
65
<refname>imageaffine</refname>
@@ -10,10 +9,10 @@
109
<refsect1 role="description">
1110
&reftitle.description;
1211
<methodsynopsis>
13-
<type class="union"><type>resource</type><type>false</type></type><methodname>imageaffine</methodname>
14-
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
12+
<type class="union"><type>GdImage</type><type>false</type></type><methodname>imageaffine</methodname>
13+
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
1514
<methodparam><type>array</type><parameter>affine</parameter></methodparam>
16-
<methodparam choice="opt"><type>array</type><parameter>clip</parameter></methodparam>
15+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>clip</parameter><initializer>&null;</initializer></methodparam>
1716
</methodsynopsis>
1817
<para>
1918

@@ -39,7 +38,7 @@
3938
<term><parameter>clip</parameter></term>
4039
<listitem>
4140
<para>
42-
Array with keys "x", "y", "width" and "height".
41+
Array with keys "x", "y", "width" and "height"; or &null;.
4342
</para>
4443
</listitem>
4544
</varlistentry>
@@ -49,12 +48,40 @@
4948
<refsect1 role="returnvalues">
5049
&reftitle.returnvalues;
5150
<para>
52-
Return affined image resource on success&return.falseforfailure;.
51+
Return affined image object on success&return.falseforfailure;.
5352
</para>
5453
</refsect1>
5554

56-
</refentry>
55+
<refsect1 role="changelog">
56+
&reftitle.changelog;
57+
<informaltable>
58+
<tgroup cols="2">
59+
<thead>
60+
<row>
61+
<entry>&Version;</entry>
62+
<entry>&Description;</entry>
63+
</row>
64+
</thead>
65+
<tbody>
66+
<row>
67+
<entry>8.0.0</entry>
68+
<entry>
69+
<parameter>clip</parameter> is now nullable.
70+
</entry>
71+
</row>
72+
<row>
73+
<entry>8.0.0</entry>
74+
<entry>
75+
On success, this function returns a <classname>GDImage</classname> instance now;
76+
previously, a <type>resource</type> was returned.
77+
</entry>
78+
</row>
79+
</tbody>
80+
</tgroup>
81+
</informaltable>
82+
</refsect1>
5783

84+
</refentry>
5885
<!-- Keep this comment at the end of the file
5986
Local variables:
6087
mode: sgml

‎reference/image/functions/imageaffinematrixconcat.xml

Lines changed: 4 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="function.imageaffinematrixconcat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
54
<refnamediv>
65
<refname>imageaffinematrixconcat</refname>
@@ -11,8 +10,8 @@
1110
&reftitle.description;
1211
<methodsynopsis>
1312
<type class="union"><type>array</type><type>false</type></type><methodname>imageaffinematrixconcat</methodname>
14-
<methodparam><type>array</type><parameter>m1</parameter></methodparam>
15-
<methodparam><type>array</type><parameter>m2</parameter></methodparam>
13+
<methodparam><type>array</type><parameter>matrix1</parameter></methodparam>
14+
<methodparam><type>array</type><parameter>matrix2</parameter></methodparam>
1615
</methodsynopsis>
1716
<para>
1817
Returns the concatenation of two affine transformation matrices,
@@ -25,7 +24,7 @@
2524
&reftitle.parameters;
2625
<variablelist>
2726
<varlistentry>
28-
<term><parameter>m1</parameter></term>
27+
<term><parameter>matrix1</parameter></term>
2928
<listitem>
3029
<para>
3130
An affine transformation matrix (an array with keys
@@ -34,7 +33,7 @@
3433
</listitem>
3534
</varlistentry>
3635
<varlistentry>
37-
<term><parameter>m2</parameter></term>
36+
<term><parameter>matrix2</parameter></term>
3837
<listitem>
3938
<para>
4039
An affine transformation matrix (an array with keys
@@ -96,7 +95,6 @@ Array
9695
</refsect1>
9796

9897
</refentry>
99-
10098
<!-- Keep this comment at the end of the file
10199
Local variables:
102100
mode: sgml

‎reference/image/functions/imageaffinematrixget.xml

Lines changed: 1 addition & 3 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="function.imageaffinematrixget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
54
<refnamediv>
65
<refname>imageaffinematrixget</refname>
@@ -12,7 +11,7 @@
1211
<methodsynopsis>
1312
<type class="union"><type>array</type><type>false</type></type><methodname>imageaffinematrixget</methodname>
1413
<methodparam><type>int</type><parameter>type</parameter></methodparam>
15-
<methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam>
14+
<methodparam><type class="union"><type>array</type><type>float</type></type><parameter>options</parameter></methodparam>
1615
</methodsynopsis>
1716
<para>
1817
Returns an affine transformation matrix.
@@ -98,7 +97,6 @@ Array
9897
</refsect1>
9998

10099
</refentry>
101-
102100
<!-- Keep this comment at the end of the file
103101
Local variables:
104102
mode: sgml

‎reference/image/functions/imagealphablending.xml

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
&reftitle.description;
1010
<methodsynopsis>
1111
<type>bool</type><methodname>imagealphablending</methodname>
12-
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
13-
<methodparam><type>bool</type><parameter>blendmode</parameter></methodparam>
12+
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
13+
<methodparam><type>bool</type><parameter>enable</parameter></methodparam>
1414
</methodsynopsis>
1515
<para>
1616
<function>imagealphablending</function> allows for two different
@@ -31,7 +31,7 @@
3131
<variablelist>
3232
&gd.image.description;
3333
<varlistentry>
34-
<term><parameter>blendmode</parameter></term>
34+
<term><parameter>enable</parameter></term>
3535
<listitem>
3636
<para>
3737
Whether to enable the blending mode or not. On true color images
@@ -48,6 +48,24 @@
4848
&return.success;
4949
</para>
5050
</refsect1>
51+
52+
<refsect1 role="changelog">
53+
&reftitle.changelog;
54+
<informaltable>
55+
<tgroup cols="2">
56+
<thead>
57+
<row>
58+
<entry>&Version;</entry>
59+
<entry>&Description;</entry>
60+
</row>
61+
</thead>
62+
<tbody>
63+
&gd.changelog.image-param;
64+
</tbody>
65+
</tgroup>
66+
</informaltable>
67+
</refsect1>
68+
5169
<refsect1 role="examples">
5270
&reftitle.examples;
5371
<example>
@@ -75,7 +93,6 @@ imagedestroy($im);
7593
</example>
7694
</refsect1>
7795
</refentry>
78-
7996
<!-- Keep this comment at the end of the file
8097
Local variables:
8198
mode: sgml

‎reference/image/functions/imageantialias.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
&reftitle.description;
1010
<methodsynopsis>
1111
<type>bool</type><methodname>imageantialias</methodname>
12-
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
13-
<methodparam><type>bool</type><parameter>enabled</parameter></methodparam>
12+
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
13+
<methodparam><type>bool</type><parameter>enable</parameter></methodparam>
1414
</methodsynopsis>
1515
<para>
1616
Activate the fast drawing antialiased methods for lines and wired polygons.
@@ -33,7 +33,7 @@
3333
<variablelist>
3434
&gd.image.description;
3535
<varlistentry>
36-
<term><parameter>enabled</parameter></term>
36+
<term><parameter>enable</parameter></term>
3737
<listitem>
3838
<para>
3939
Whether to enable antialiasing or not.
@@ -61,6 +61,7 @@
6161
</row>
6262
</thead>
6363
<tbody>
64+
&gd.changelog.image-param;
6465
<row>
6566
<entry>7.2.0</entry>
6667
<entry>
@@ -127,7 +128,6 @@ imagedestroy($normal);
127128
</simplelist>
128129
</refsect1>
129130
</refentry>
130-
131131
<!-- Keep this comment at the end of the file
132132
Local variables:
133133
mode: sgml

‎reference/image/functions/imagearc.xml

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
&reftitle.description;
1010
<methodsynopsis>
1111
<type>bool</type><methodname>imagearc</methodname>
12-
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
13-
<methodparam><type>int</type><parameter>cx</parameter></methodparam>
14-
<methodparam><type>int</type><parameter>cy</parameter></methodparam>
12+
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
13+
<methodparam><type>int</type><parameter>center_x</parameter></methodparam>
14+
<methodparam><type>int</type><parameter>center_y</parameter></methodparam>
1515
<methodparam><type>int</type><parameter>width</parameter></methodparam>
1616
<methodparam><type>int</type><parameter>height</parameter></methodparam>
17-
<methodparam><type>int</type><parameter>start</parameter></methodparam>
18-
<methodparam><type>int</type><parameter>end</parameter></methodparam>
17+
<methodparam><type>int</type><parameter>start_angle</parameter></methodparam>
18+
<methodparam><type>int</type><parameter>end_angle</parameter></methodparam>
1919
<methodparam><type>int</type><parameter>color</parameter></methodparam>
2020
</methodsynopsis>
2121
<para>
@@ -29,15 +29,15 @@
2929
<variablelist>
3030
&gd.image.description;
3131
<varlistentry>
32-
<term><parameter>cx</parameter></term>
32+
<term><parameter>center_x</parameter></term>
3333
<listitem>
3434
<para>
3535
x-coordinate of the center.
3636
</para>
3737
</listitem>
3838
</varlistentry>
3939
<varlistentry>
40-
<term><parameter>cy</parameter></term>
40+
<term><parameter>center_y</parameter></term>
4141
<listitem>
4242
<para>
4343
y-coordinate of the center.
@@ -61,15 +61,15 @@
6161
</listitem>
6262
</varlistentry>
6363
<varlistentry>
64-
<term><parameter>start</parameter></term>
64+
<term><parameter>start_angle</parameter></term>
6565
<listitem>
6666
<para>
6767
The arc start angle, in degrees.
6868
</para>
6969
</listitem>
7070
</varlistentry>
7171
<varlistentry>
72-
<term><parameter>end</parameter></term>
72+
<term><parameter>end_angle</parameter></term>
7373
<listitem>
7474
<para>
7575
The arc end angle, in degrees.
@@ -95,6 +95,24 @@
9595
&return.success;
9696
</para>
9797
</refsect1>
98+
99+
<refsect1 role="changelog">
100+
&reftitle.changelog;
101+
<informaltable>
102+
<tgroup cols="2">
103+
<thead>
104+
<row>
105+
<entry>&Version;</entry>
106+
<entry>&Description;</entry>
107+
</row>
108+
</thead>
109+
<tbody>
110+
&gd.changelog.image-param;
111+
</tbody>
112+
</tgroup>
113+
</informaltable>
114+
</refsect1>
115+
98116
<refsect1 role="examples">
99117
&reftitle.examples;
100118
<para>
@@ -150,7 +168,6 @@ imagedestroy($img);
150168
</simplelist>
151169
</refsect1>
152170
</refentry>
153-
154171
<!-- Keep this comment at the end of the file
155172
Local variables:
156173
mode: sgml

0 commit comments

Comments
 (0)