Document constructor.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@274932 c90b9560-bf6c-de11-be94-00142212c4b1

reference/memcached/book.xml

@@ -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

reference/memcached/memcached.xml

@@ -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>
 <!-- }}} -->

reference/memcached/memcached/construct.xml

@@ -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