[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] cvs: phpdoc /en/reference/memcached book.xml memcached.xml /en/reference/memcached/memcac
From: "Andrei Zmievski" <andrei () php ! net>
Date: 2009-01-30 19:13:23
Message-ID: cvsandrei1233342803 () cvsserver
[Download RAW message or body]
andrei Fri Jan 30 19:13:23 2009 UTC
Modified files:
/phpdoc/en/reference/memcached book.xml memcached.xml
/phpdoc/en/reference/memcached/memcached construct.xml
Log:
Document constructor.
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcached/book.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/memcached/book.xml
diff -u phpdoc/en/reference/memcached/book.xml:1.1 \
phpdoc/en/reference/memcached/book.xml:1.2
--- phpdoc/en/reference/memcached/book.xml:1.1 Fri Jan 30 00:04:29 2009
+++ phpdoc/en/reference/memcached/book.xml Fri Jan 30 19:13:21 2009
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<book xml:id="book.memcached" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> <title>Memcached</title>
@@ -7,6 +7,11 @@
<preface xml:id="intro.memcached">
&reftitle.intro;
+ <note>
+ <para>
+ The documentation is currently being worked on.
+ </para>
+ </note>
<para>
<link xlink:href="&url.memcache;">memcached</link> is a high-performance,
distributed memory object caching system, generic in nature, but intended
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcached/memcached.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/memcached/memcached.xml
diff -u phpdoc/en/reference/memcached/memcached.xml:1.2 \
phpdoc/en/reference/memcached/memcached.xml:1.3
--- phpdoc/en/reference/memcached/memcached.xml:1.2 Fri Jan 30 17:36:47 2009
+++ phpdoc/en/reference/memcached/memcached.xml Fri Jan 30 19:13:22 2009
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<phpdoc:classref xml:id="class.memcached" xmlns:phpdoc="http://php.net/ns/phpdoc" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" \
xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -12,7 +12,7 @@
<section xml:id="memcached.intro">
&reftitle.intro;
<para>
- Description of the class.
+ Represents a connection to a set of memcached servers.
</para>
</section>
<!-- }}} -->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcached/memcached/construct.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/memcached/memcached/construct.xml
diff -u phpdoc/en/reference/memcached/memcached/construct.xml:1.2 \
phpdoc/en/reference/memcached/memcached/construct.xml:1.3
--- phpdoc/en/reference/memcached/memcached/construct.xml:1.2 Fri Jan 30 17:36:47 \
2009
+++ phpdoc/en/reference/memcached/memcached/construct.xml Fri Jan 30 19:13:23 2009
@@ -1,10 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.construct" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv>
<refname>Memcached::__construct</refname>
- <refpurpose>The __construct purpose</refpurpose>
+ <refpurpose>Creates a Memcached instance representing the connection to the
+ memcache servers</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -14,7 +15,8 @@
<methodparam choice="opt"><type>string</type><parameter>persistent_id</parameter></methodparam>
</constructorsynopsis>
<para>
- The method description goes here.
+ Creates a Memcached instance representing the connection to the memcache
+ servers.
</para>
</refsect1>
@@ -26,7 +28,11 @@
<term><parameter>persistent_id</parameter></term>
<listitem>
<para>
- Description...
+ By default the Memcached instances are destroyed at the end of the
+ request. To create an instance that persists between requests, use
+ <parameter>persistent_id</parameter> to specify a unique ID for the
+ instance. All instances created with the same
+ <parameter>persistent_id</parameter> will share the same connection.
</para>
</listitem>
</varlistentry>
@@ -37,7 +43,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Description...
+ A Memcached object.
</para>
</refsect1>
@@ -45,33 +51,26 @@
&reftitle.examples;
<para>
<example>
- <title><function>Memcached::__construct</function> example</title>
+ <title>Creating a Memcached object</title>
<programlisting role="php">
<![CDATA[
-<?php
-/* ... */
+/* Create a regular instance */
+$m1 = new Memcached();
+echo get_class($m);
+
+/* Create a persistent instance */
+$m2 = new Memcached('story_pool');
+...
+$m3 = new Memcached('story_pool);
+/* now $m2 and $m3 share the same connection */
+
?>
]]>
</programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
</example>
</para>
</refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>Classname::Method</methodname></member>
- </simplelist>
- </para>
- </refsect1>
-
</refentry>
<!-- Keep this comment at the end of the file
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic