From a1c1c7e395eb11e8dd69ef309c8216123ad5388b Mon Sep 17 00:00:00 2001
From: Joe Watkins <krakjoe@php.net>
Date: Fri, 12 Sep 2014 15:28:30 +0000
Subject: [PATCH] remaining docs for Collectable

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334851 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/pthreads/book.xml        |  1 +
 reference/pthreads/collectable.xml | 76 ++++++++++++++++++++++++++++++
 reference/pthreads/versions.xml    |  4 ++
 3 files changed, 81 insertions(+)
 create mode 100644 reference/pthreads/collectable.xml

diff --git a/reference/pthreads/book.xml b/reference/pthreads/book.xml
index 23b98c3f5b..8cae399bbd 100644
--- a/reference/pthreads/book.xml
+++ b/reference/pthreads/book.xml
@@ -90,6 +90,7 @@
  &reference.pthreads.threaded;
  &reference.pthreads.thread;
  &reference.pthreads.worker;
+ &reference.pthreads.collectable;
  &reference.pthreads.modifiers;
  &reference.pthreads.pool;
  &reference.pthreads.mutex;
diff --git a/reference/pthreads/collectable.xml b/reference/pthreads/collectable.xml
new file mode 100644
index 0000000000..0bea836ba1
--- /dev/null
+++ b/reference/pthreads/collectable.xml
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:classref xml:id="class.collectable" 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">
+
+ <title>The Collectable class</title>
+ <titleabbrev>Collectable</titleabbrev>
+  
+ <partintro>
+
+<!-- {{{ Collectable intro -->
+  <section xml:id="collectable.intro">
+   &reftitle.intro;
+   <para>
+  Collectable objects are intended to be used by the Pool class, replacing Threaded objects as the unit of work, they provide methods to set and detect the collectability of an object.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="collectable.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>Collectable</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>Collectable</classname>
+     </ooclass>
+     
+     <ooclass>
+      <modifier>extends</modifier>
+      <classname>Threaded</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+    
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.collectable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+    
+    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.threaded')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.pthreads.entities.collectable;
+
+</phpdoc:classref>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/pthreads/versions.xml b/reference/pthreads/versions.xml
index 0b8e56fcb3..c9a144ce49 100644
--- a/reference/pthreads/versions.xml
+++ b/reference/pthreads/versions.xml
@@ -109,6 +109,10 @@
  <function name='pool::collect' from='PECL pthreads &gt;= 2.0.0'/>
  <function name='pool::shutdown' from='PECL pthreads &gt;= 2.0.0'/>
  <function name='pool::__destruct' from='PECL pthreads &gt;= 2.0.0'/>
+ 
+ <function name='collectable' from='PECL pthreads &gt;= 2.0.8'/>
+ <function name='collectable::isgarbage' from='PECL pthreads &gt;= 2.0.8'/>
+ <function name='collectable::setgarbage' from='PECL pthreads &gt;= 2.0.8'/>
 </versions>
 
 <!-- Keep this comment at the end of the file