cvs: phpdoc /en/reference/memcache/functions memcache-add.xml memcache-addserver.xml memcache-connect.xml memcache-decrement.xml
memcache-increment.xml memcache-pconnect.xml memcache-replace.xml memcache-set.xml

tony2001 Sun Dec 25 22:33:24 2005 EDT Modified files: /phpdoc/en/reference/memcache/functions memcache-add.xml memcache-addserver.xml memcache-connect.xml memcache-decrement.xml memcache-increment.xml memcache-pconnect.xml memcache-replace.xml memcache-set.xml Log: add more param descriptions fix typos

http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/memcache/functions/memcache-add.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-add.xml diff -u phpdoc/en/reference/memcache/functions/memcache-add.xml:1.2 phpdoc/en/reference/memcache/functions/memcache-add.xml:1.3 --- phpdoc/en/reference/memcache/functions/memcache-add.xml:1.2 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-add.xml Sun Dec 25 22:33:24 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.Memcache-add"> <refnamediv> <refname>Memcache::add</refname> @@ -33,6 +33,7 @@ <term><parameter>key</parameter></term> <listitem> <para> + The key that will be associated with the item. </para> </listitem> </varlistentry> @@ -40,6 +41,8 @@ <term><parameter>var</parameter></term> <listitem> <para> + The variable to store. Strings and integers are stored as is, other + types are stored serialized. </para> </listitem> </varlistentry> @@ -47,6 +50,8 @@ <term><parameter>flag</parameter></term> <listitem> <para> + Use <constant>MEMCACHE_COMPRESSED</constant> to store the item + compressed (uses zlib). </para> </listitem> </varlistentry> @@ -54,6 +59,10 @@ <term><parameter>expire</parameter></term> <listitem> <para> + Expiration time of the item. If it's equal to zero, the item will never + expire. You can also use unix timestamp or a number of seconds starting + from current time, but in the latter case the number of seconds may not + exceed 2592000 (30 days). </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/memcache/functions/memcache-addserver.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-addserver.xml diff -u phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.3 phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.4 --- phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.3 Sat Dec 24 23:04:58 2005 +++ phpdoc/en/reference/memcache/functions/memcache-addserver.xml Sun Dec 25 22:33:24 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.Memcache-addServer"> <refnamediv> <refname>Memcache::addServer</refname> @@ -81,7 +81,7 @@ <para> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can loose all - the advantages of caching if you connection is too slow. + the advantages of caching if your connection is too slow. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/memcache/functions/memcache-connect.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-connect.xml diff -u phpdoc/en/reference/memcache/functions/memcache-connect.xml:1.3 phpdoc/en/reference/memcache/functions/memcache-connect.xml:1.4 --- phpdoc/en/reference/memcache/functions/memcache-connect.xml:1.3 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-connect.xml Sun Dec 25 22:33:24 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.Memcache-connect"> <refnamediv> <refname>Memcache::connect</refname> @@ -53,7 +53,7 @@ <para> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can loose all - the advantages of caching if you connection is too slow. + the advantages of caching if your connection is too slow. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/memcache/functions/memcache-decrement.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-decrement.xml diff -u phpdoc/en/reference/memcache/functions/memcache-decrement.xml:1.2 phpdoc/en/reference/memcache/functions/memcache-decrement.xml:1.3 --- phpdoc/en/reference/memcache/functions/memcache-decrement.xml:1.2 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-decrement.xml Sun Dec 25 22:33:24 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.Memcache-decrement"> <refnamediv> <refname>Memcache::decrement</refname> @@ -47,6 +47,7 @@ <term><parameter>key</parameter></term> <listitem> <para> + Key of the item do decrement. </para> </listitem> </varlistentry> @@ -54,7 +55,7 @@ <term><parameter>value</parameter></term> <listitem> <para> - Optionnal and default to 1. + Decrement the item by <parameter>value</parameter>. Optional and defaults to 1. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/memcache/functions/memcache-increment.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-increment.xml diff -u phpdoc/en/reference/memcache/functions/memcache-increment.xml:1.2 phpdoc/en/reference/memcache/functions/memcache-increment.xml:1.3 --- phpdoc/en/reference/memcache/functions/memcache-increment.xml:1.2 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-increment.xml Sun Dec 25 22:33:24 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.Memcache-increment"> <refnamediv> <refname>Memcache::increment</refname> @@ -41,6 +41,7 @@ <term><parameter>key</parameter></term> <listitem> <para> + Key of the item to increment. </para> </listitem> </varlistentry> @@ -48,7 +49,7 @@ <term><parameter>value</parameter></term> <listitem> <para> - Optional and default to 1. + Increment the item by <parameter>value</parameter>. Optional and defaults to 1. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/memcache/functions/memcache-pconnect.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-pconnect.xml diff -u phpdoc/en/reference/memcache/functions/memcache-pconnect.xml:1.2 phpdoc/en/reference/memcache/functions/memcache-pconnect.xml:1.3 --- phpdoc/en/reference/memcache/functions/memcache-pconnect.xml:1.2 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-pconnect.xml Sun Dec 25 22:33:24 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.Memcache-pconnect"> <refnamediv> <refname>Memcache::pconnect</refname> @@ -52,7 +52,7 @@ <para> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can loose all - the advantages of caching if you connection is too slow. + the advantages of caching if your connection is too slow. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/memcache/functions/memcache-replace.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-replace.xml diff -u phpdoc/en/reference/memcache/functions/memcache-replace.xml:1.2 phpdoc/en/reference/memcache/functions/memcache-replace.xml:1.3 --- phpdoc/en/reference/memcache/functions/memcache-replace.xml:1.2 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-replace.xml Sun Dec 25 22:33:24 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.Memcache-replace"> <refnamediv> <refname>Memcache::replace</refname> @@ -35,6 +35,7 @@ <term><parameter>key</parameter></term> <listitem> <para> + The key that will be associated with the item. </para> </listitem> </varlistentry> @@ -42,6 +43,8 @@ <term><parameter>var</parameter></term> <listitem> <para> + The variable to store. Strings and integers are stored as is, other + types are stored serialized. </para> </listitem> </varlistentry> @@ -49,6 +52,8 @@ <term><parameter>flag</parameter></term> <listitem> <para> + Use <constant>MEMCACHE_COMPRESSED</constant> to store the item + compressed (uses zlib). </para> </listitem> </varlistentry> @@ -56,13 +61,17 @@ <term><parameter>expire</parameter></term> <listitem> <para> + Expiration time of the item. If it's equal to zero, the item will never + expire. You can also use unix timestamp or a number of seconds starting + from current time, but in the latter case the number of seconds may not + exceed 2592000 (30 days). </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> - + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/memcache/functions/memcache-set.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-set.xml diff -u phpdoc/en/reference/memcache/functions/memcache-set.xml:1.3 phpdoc/en/reference/memcache/functions/memcache-set.xml:1.4 --- phpdoc/en/reference/memcache/functions/memcache-set.xml:1.3 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-set.xml Sun Dec 25 22:33:24 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.Memcache-set"> <refnamediv> <refname>Memcache::set</refname> @@ -46,6 +46,7 @@ <term><parameter>key</parameter></term> <listitem> <para> + The key that will be associated with the item. </para> </listitem> </varlistentry> @@ -53,6 +54,8 @@ <term><parameter>var</parameter></term> <listitem> <para> + The variable to store. Strings and integers are stored as is, other + types are stored serialized. </para> </listitem> </varlistentry> @@ -60,6 +63,8 @@ <term><parameter>flag</parameter></term> <listitem> <para> + Use <constant>MEMCACHE_COMPRESSED</constant> to store the item + compressed (uses zlib). </para> </listitem> </varlistentry> @@ -67,13 +72,17 @@ <term><parameter>expire</parameter></term> <listitem> <para> + Expiration time of the item. If it's equal to zero, the item will never + expire. You can also use unix timestamp or a number of seconds starting + from current time, but in the latter case the number of seconds may not + exceed 2592000 (30 days). </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> - + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para>