From 2b8b9437832fd27be61605ed574d49a2ea4c6cf0 Mon Sep 17 00:00:00 2001
From: Etienne Kneuss <colder@php.net>
Date: Mon, 12 May 2008 11:30:46 +0000
Subject: [PATCH] And the class sypnosis

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259616 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/spldoublylinkedlist.xml | 103 +++++++++++++++++++++++
 reference/spl/splqueue.xml            | 112 ++++++++++++++++++++++++++
 reference/spl/splstack.xml            | 112 ++++++++++++++++++++++++++
 3 files changed, 327 insertions(+)
 create mode 100644 reference/spl/spldoublylinkedlist.xml
 create mode 100644 reference/spl/splqueue.xml
 create mode 100644 reference/spl/splstack.xml

diff --git a/reference/spl/spldoublylinkedlist.xml b/reference/spl/spldoublylinkedlist.xml
new file mode 100644
index 0000000000..6509b273f7
--- /dev/null
+++ b/reference/spl/spldoublylinkedlist.xml
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+<reference xml:id="class.spldoublylinkedlist" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>The SplDoublyLinkedList class</title>
+ <titleabbrev>SplDoublyLinkedList</titleabbrev>
+ 
+ <partintro>
+ 
+<!-- {{{ spldoublylinkedlist intro -->
+  <section xml:id="spldoublylinkedlist.intro">
+   &reftitle.intro;
+   <para>
+    The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.
+   </para>
+  </section>
+<!-- }}} -->
+ 
+  <section xml:id="spldoublylinkedlist.synopsis">
+   &reftitle.classsynopsis;
+ 
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>SplDoublyLinkedList</classname></ooclass>
+ 
+<!-- {{{ Class synopsis -->
+
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>SplDoublyLinkedList</classname>
+     </ooclass>
+
+     <oointerface>
+      <interfacename>Iterator</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>ArrayAccess</interfacename>
+     </oointerface>
+ 
+     <oointerface>
+      <interfacename>Countable</interfacename>
+     </oointerface>
+ 
+    </classsynopsisinfo>
+<!-- }}} -->
+ 
+    <!-- {{{ If the property is documented below (xml:id=spldoublylinkedlist.props) use this
+    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <type>string</type>
+     <varname linkend="spldoublylinkedlist.props.name">name</varname>
+    </fieldsynopsis>
+    }}} -->
+ 
+    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spldoublylinkedlist')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spldoublylinkedlist')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+ 
+  </section>
+ 
+<!-- {{{ spldoublylinkedlist properties
+  <section xml:id="spldoublylinkedlist.props">
+   &reftitle.properties;
+   <variablelist>
+    <varlistentry xml:id="spldoublylinkedlist.props.name">
+     <term><varname>name</varname></term>
+     <listitem>
+      <para>Prop description</para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+}}} -->
+ 
+ </partintro>
+ 
+ &reference.spl.entities.spldoublylinkedlist;
+ 
+</reference>
+ 
+<!-- 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:"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/spl/splqueue.xml b/reference/spl/splqueue.xml
new file mode 100644
index 0000000000..a18e23b5c7
--- /dev/null
+++ b/reference/spl/splqueue.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+<reference xml:id="class.splqueue" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>The SplQueue class</title>
+ <titleabbrev>SplQueue</titleabbrev>
+ 
+ <partintro>
+ 
+<!-- {{{ splqueue intro -->
+  <section xml:id="splqueue.intro">
+   &reftitle.intro;
+   <para>
+    The SplQueue class provides the main functionalities of a queue implemented using a doubly linked list.
+   </para>
+  </section>
+<!-- }}} -->
+ 
+  <section xml:id="splqueue.synopsis">
+   &reftitle.classsynopsis;
+ 
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>SplQueue</classname></ooclass>
+ 
+<!-- {{{ Class synopsis -->
+
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>SplQueue</classname>
+     </ooclass>
+
+     <ooclass>
+      <modifier>extends</modifier>
+      <classname>SplDoublyLinkedList</classname>
+     </ooclass>
+
+     <oointerface>
+      <interfacename>Iterator</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>ArrayAccess</interfacename>
+     </oointerface>
+ 
+     <oointerface>
+      <interfacename>Countable</interfacename>
+     </oointerface>
+ 
+    </classsynopsisinfo>
+<!-- }}} -->
+ 
+    <!-- {{{ If the property is documented below (xml:id=splqueue.props) use this
+    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <type>string</type>
+     <varname linkend="splqueue.props.name">name</varname>
+    </fieldsynopsis>
+    }}} -->
+ 
+    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+
+    <classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spldoublylinkedlist')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+ 
+  </section>
+
+
+<!-- {{{ splqueue properties
+  <section xml:id="splqueue.props">
+   &reftitle.properties;
+   <variablelist>
+    <varlistentry xml:id="splqueue.props.name">
+     <term><varname>name</varname></term>
+     <listitem>
+      <para>Prop description</para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+}}} -->
+ 
+ </partintro>
+ 
+ &reference.spl.entities.splqueue;
+
+</reference>
+ 
+<!-- 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:"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/spl/splstack.xml b/reference/spl/splstack.xml
new file mode 100644
index 0000000000..a41340a9d9
--- /dev/null
+++ b/reference/spl/splstack.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+<reference xml:id="class.splstack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>The SplStack class</title>
+ <titleabbrev>SplStack</titleabbrev>
+ 
+ <partintro>
+ 
+<!-- {{{ splstack intro -->
+  <section xml:id="splstack.intro">
+   &reftitle.intro;
+   <para>
+    The SplStack class provides the main functionalities of a stack implemented using a doubly linked list.
+   </para>
+  </section>
+<!-- }}} -->
+ 
+  <section xml:id="splstack.synopsis">
+   &reftitle.classsynopsis;
+ 
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>SplStack</classname></ooclass>
+ 
+<!-- {{{ Class synopsis -->
+
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>SplStack</classname>
+     </ooclass>
+
+     <ooclass>
+      <modifier>extends</modifier>
+      <classname>SplDoublyLinkedList</classname>
+     </ooclass>
+
+     <oointerface>
+      <interfacename>Iterator</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>ArrayAccess</interfacename>
+     </oointerface>
+ 
+     <oointerface>
+      <interfacename>Countable</interfacename>
+     </oointerface>
+ 
+    </classsynopsisinfo>
+<!-- }}} -->
+ 
+    <!-- {{{ If the property is documented below (xml:id=splstack.props) use this
+    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <type>string</type>
+     <varname linkend="splstack.props.name">name</varname>
+    </fieldsynopsis>
+    }}} -->
+ 
+    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splstack')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splstack')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+
+    <classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spldoublylinkedlist')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+ 
+  </section>
+
+
+<!-- {{{ splstack properties
+  <section xml:id="splstack.props">
+   &reftitle.properties;
+   <variablelist>
+    <varlistentry xml:id="splstack.props.name">
+     <term><varname>name</varname></term>
+     <listitem>
+      <para>Prop description</para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+}}} -->
+ 
+ </partintro>
+ 
+ &reference.spl.entities.splstack;
+ 
+</reference>
+ 
+<!-- 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:"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
+-->
+