sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 08:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Generate various method synopses based on stubs

Browse source 
Closes GH-1015.
This commit is contained in:
Máté Kocsis 2021-10-11 23:49:55 +02:00 committed by Christoph M. Becker
parent c3067ab0a7
commit 5b4252de4f
No known key found for this signature in database
GPG key ID: D66C9593118BCCB6
9 changed files with 19 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
reference/oci8/OCI-Lob/close.xml
View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OCILob::close</methodname>
<void/>
</methodsynopsis>

2
reference/oci8/OCI-Lob/writeTemporary.xml
View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OCILob::writeTemporary</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer><constant>OCI_TEMP_CLOB</constant></initializer></methodparam>

19
reference/outcontrol/functions/ob-gzhandler.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ob-gzhandler">
<refentry xml:id="function.ob-gzhandler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_gzhandler</refname>
<refpurpose>ob_start callback function to gzip output buffer</refpurpose>
@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ob_gzhandler</methodname>
<methodparam><type>string</type><parameter>buffer</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<type class="union"><type>string</type><type>false</type></type><methodname>ob_gzhandler</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
<function>ob_gzhandler</function> is intended to be used as a callback
@ -31,14 +31,14 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<term><parameter>data</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<para>
</para>
@ -82,14 +82,12 @@ ob_start("ob_gzhandler");
&reftitle.notes;
<note>
<para>
<function>ob_gzhandler</function> requires the <link
linkend="ref.zlib">zlib</link> extension.
<function>ob_gzhandler</function> requires the <link linkend="ref.zlib">zlib</link> extension.
</para>
</note>
<note>
<para>
You cannot use both <function>ob_gzhandler</function> and <link
linkend="ini.zlib.output-compression">zlib.output_compression</link>.
You cannot use both <function>ob_gzhandler</function> and <link linkend="ini.zlib.output-compression">zlib.output_compression</link>.
Also note that using <link linkend="ini.zlib.output-compression">
zlib.output_compression</link> is preferred over
<function>ob_gzhandler</function>.
@ -108,7 +106,6 @@ ob_start("ob_gzhandler");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/outcontrol/functions/ob-implicit-flush.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ob-implicit-flush">
<refentry xml:id="function.ob-implicit-flush" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_implicit_flush</refname>
<refpurpose>Turn implicit flush on/off</refpurpose>
@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>ob_implicit_flush</methodname>
<methodparam choice="opt"><type>bool</type><parameter>flag</parameter><initializer>true</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>enable</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
<function>ob_implicit_flush</function> will turn implicit flushing on or
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>flag</parameter></term>
<term><parameter>enable</parameter></term>
<listitem>
<para>
<literal>true</literal> to turn implicit flushing on, <literal>false</literal> otherwise.
@ -57,7 +57,7 @@
<row>
<entry>8.0.0</entry>
<entry>
The <parameter>flag</parameter> expects a <type>bool</type> value now;
The <parameter>enable</parameter> expects a <type>bool</type> value now;
previously, an <type>int</type> was expected.
</entry>
</row>
@ -78,7 +78,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

2
reference/phar/Phar/convertToData.xml
View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>Phar</type><type>null</type></type><methodname>Phar::convertToData</methodname>
<modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>Phar::convertToData</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>format</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>compression</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>

2
reference/phar/PharData/compress.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>Phar</type><type>null</type></type><methodname>PharData::compress</methodname>
<modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>PharData::compress</methodname>
<methodparam><type>int</type><parameter>compression</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>

2
reference/phar/PharData/convertToData.xml
View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>Phar</type><type>null</type></type><methodname>PharData::convertToData</methodname>
<modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>PharData::convertToData</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>format</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>compression</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>

2
reference/phar/PharData/decompress.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>Phar</type><type>null</type></type><methodname>PharData::decompress</methodname>
<modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>PharData::decompress</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>

2
reference/snmp/snmp/get.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>bool</type></type><methodname>SNMP::get</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>SNMP::get</methodname>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>objectId</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>preserveKeys</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>