Skip to content

Commit 310963a

Browse files
authored
Make cURL docs DocBook 5.2 conformant (#3383)
1 parent 45c797b commit 310963a

File tree

2 files changed

+264
-144
lines changed

2 files changed

+264
-144
lines changed

reference/curl/functions/curl-multi-setopt.xml

Lines changed: 41 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -126,43 +126,47 @@
126126
<row>
127127
<entry valign="top"><constant>CURLMOPT_PUSHFUNCTION</constant></entry>
128128
<entry valign="top">
129-
Pass a <type>callable</type> that will be registered to handle server
130-
pushes and should have the following signature:
131-
<methodsynopsis>
132-
<type>int</type><methodname><replaceable>pushfunction</replaceable></methodname>
133-
<methodparam><type>resource</type><parameter>parent_ch</parameter></methodparam>
134-
<methodparam><type>resource</type><parameter>pushed_ch</parameter></methodparam>
135-
<methodparam><type>array</type><parameter>headers</parameter></methodparam>
136-
</methodsynopsis>
137-
<variablelist>
138-
<varlistentry>
139-
<term><parameter>parent_ch</parameter></term>
140-
<listitem>
141-
<para>
142-
The parent cURL handle (the request the client made).
143-
</para>
144-
</listitem>
145-
</varlistentry>
146-
<varlistentry>
147-
<term><parameter>pushed_ch</parameter></term>
148-
<listitem>
149-
<para>
150-
A new cURL handle for the pushed request.
151-
</para>
152-
</listitem>
153-
</varlistentry>
154-
<varlistentry>
155-
<term><parameter>headers</parameter></term>
156-
<listitem>
157-
<para>
158-
The push promise headers.
159-
</para>
160-
</listitem>
161-
</varlistentry>
162-
</variablelist>
163-
The push function is supposed to return either
164-
<constant>CURL_PUSH_OK</constant> if it can handle the push, or
165-
<constant>CURL_PUSH_DENY</constant> to reject it.
129+
<para>
130+
Pass a <type>callable</type> that will be registered to handle server
131+
pushes and should have the following signature:
132+
<methodsynopsis>
133+
<type>int</type><methodname><replaceable>pushfunction</replaceable></methodname>
134+
<methodparam><type>resource</type><parameter>parent_ch</parameter></methodparam>
135+
<methodparam><type>resource</type><parameter>pushed_ch</parameter></methodparam>
136+
<methodparam><type>array</type><parameter>headers</parameter></methodparam>
137+
</methodsynopsis>
138+
<variablelist>
139+
<varlistentry>
140+
<term><parameter>parent_ch</parameter></term>
141+
<listitem>
142+
<para>
143+
The parent cURL handle (the request the client made).
144+
</para>
145+
</listitem>
146+
</varlistentry>
147+
<varlistentry>
148+
<term><parameter>pushed_ch</parameter></term>
149+
<listitem>
150+
<para>
151+
A new cURL handle for the pushed request.
152+
</para>
153+
</listitem>
154+
</varlistentry>
155+
<varlistentry>
156+
<term><parameter>headers</parameter></term>
157+
<listitem>
158+
<para>
159+
The push promise headers.
160+
</para>
161+
</listitem>
162+
</varlistentry>
163+
</variablelist>
164+
</para>
165+
<simpara>
166+
The push function is supposed to return either
167+
<constant>CURL_PUSH_OK</constant> if it can handle the push, or
168+
<constant>CURL_PUSH_DENY</constant> to reject it.
169+
</simpara>
166170
</entry>
167171
</row>
168172
</tbody>

0 commit comments

Comments
 (0)