The patch deletes the timeout parameter from the parameters
documentation, yet the parameter exists in the function signature.
Regardless of how useful a parameter is, the documentation should
match the signature/behaviour which means leaving it (but changing
its description). Right?
Ok, new patch attached. I can live with documented but deprecated.
Also,<initializer> for $timeout should be 0 in the
associated<methodparam>.
I didn't touch the methodparam block. So, I am not sure what you are
talking about.
And lastly, changes in behavour should be described in the<changelog>
role within the methods docs.
And here you really lost me. I have not done PHP doc work in 10 years so
bear with me. I am sure if you work on them every day this makes sense,
but it reads like Java to me. ;)
Brian.
Index: delete.xml
===================================================================
--- delete.xml (revision 300543)
+++ delete.xml (working copy)
@@ -15,10 +15,8 @@
</methodsynopsis>
<para>
- <function>Memcache::delete</function> deletes item with the
- <parameter>key</parameter>. If parameter <parameter>timeout</parameter>
- is specified, the item will expire after
- <parameter>timeout</parameter> seconds.
+ <function>Memcache::delete</function> deletes item with the
+ <parameter>key</parameter>
Also you can use <function>memcache_delete</function> function.
</para>
@@ -40,9 +38,7 @@
<term><parameter>timeout</parameter></term>
<listitem>
<para>
- Execution time of the item. If it's equal to zero, the item will be
- deleted right away whereas if you set it to 30, the item will be
- deleted in 30 seconds.
+ No longer supported by memcached. Do not use.
</para>
</listitem>
</varlistentry>
@@ -69,14 +65,14 @@
/* procedural API */
$memcache_obj = memcache_connect('memcache_host', 11211);
-/* after 10 seconds item will be deleted by the server */
-memcache_delete($memcache_obj, 'key_to_delete', 10);
+/* item will be deleted by the server */
+memcache_delete($memcache_obj, 'key_to_delete');
/* OO API */
$memcache_obj = new Memcache;
$memcache_obj->connect('memcache_host', 11211);
-$memcache_obj->delete('key_to_delete', 10);
+$memcache_obj->delete('key_to_delete');
?>
]]>
