reference/memcached/memcached/setoption.xml
1d8068ecb070fdc360d750e0c1f3f15796e61ec0
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="memcached.setoption" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>Memcached::setOption</refname>
...
...
@@ -9,7 +8,7 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
11
+
<methodsynopsis role="Memcached">
13
12
<modifier>public</modifier> <type>bool</type><methodname>Memcached::setOption</methodname>
14
13
<methodparam><type>int</type><parameter>option</parameter></methodparam>
15
14
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
...
...
@@ -17,19 +16,41 @@
17
16
<para>
18
17
This method sets the value of a Memcached <parameter>option</parameter>.
19
18
Some options correspond to the ones defined by libmemcached, and some are
20
-
specific to the extension. See <link linkend="memcached.constants">Memcached Constants</link> for more
21
-
information.
19
+
specific to the extension.
22
20
</para>
21
+
</refsect1>
22
+

23
+
<refsect1 role="parameters">
24
+
&reftitle.parameters;
23
25
<para>
24
-
The options listed below require values specified via constants.
25
-
<itemizedlist>
26
-
<listitem><para>
27
-
<literal>Memcached::OPT_HASH</literal> requires <literal>Memcached::HASH_*</literal> values.
28
-
</para></listitem>
29
-
<listitem><para>
30
-
<literal>Memcached::OPT_DISTRIBUTION</literal> requires <literal>Memcached::DISTRIBUTION_*</literal> values.
31
-
</para></listitem>
32
-
</itemizedlist>
26
+
<variablelist>
27
+
<varlistentry>
28
+
<term><parameter>option</parameter></term>
29
+
<listitem>
30
+
<para>
31
+
One of the <literal>Memcached::OPT_*</literal> constant.
32
+
See <link linkend="memcached.constants">Memcached Constants</link> for more information.
33
+
</para>
34
+
</listitem>
35
+
</varlistentry>
36
+
<varlistentry>
37
+
<term><parameter>value</parameter></term>
38
+
<listitem>
39
+
<para>
40
+
The value to be set.
41
+
</para>
42
+
<note>
43
+
<para>
44
+
The options listed below require values specified via constants.
45
+
<simplelist>
46
+
<member><literal>Memcached::OPT_HASH</literal> requires <literal>Memcached::HASH_*</literal> values.</member>
47
+
<member><literal>Memcached::OPT_DISTRIBUTION</literal> requires <literal>Memcached::DISTRIBUTION_*</literal> values.</member>
48
+
</simplelist>
49
+
</para>
50
+
</note>
51
+
</listitem>
52
+
</varlistentry>
53
+
</variablelist>
33
54
</para>
34
55
</refsect1>
35
56

...
...
@@ -79,7 +100,6 @@ Prefix key is now: widgets
79
100
</refsect1>
80
101

81
102
</refentry>
82
-

83
103
<!-- Keep this comment at the end of the file
84
104
Local variables:
85
105
mode: sgml
86
106