From 3eb596f94c622e648f7c2763490bb1dac7695d64 Mon Sep 17 00:00:00 2001
From: Levi Morrison <levim@php.net>
Date: Tue, 13 Dec 2011 19:32:36 +0000
Subject: [PATCH] Added the exceptions thrown when you do various things inside
 of SplDoublyLinkedList.

--
Provided by Levi Morrison (morrison.levi@gmail.com) (me)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@320965 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/spldoublylinkedlist/bottom.xml    | 15 +++++++++++----
 reference/spl/spldoublylinkedlist/offsetget.xml | 17 +++++++++++++----
 reference/spl/spldoublylinkedlist/offsetset.xml | 17 ++++++++++++-----
 .../spl/spldoublylinkedlist/offsetunset.xml     | 17 ++++++++++++-----
 reference/spl/spldoublylinkedlist/pop.xml       | 14 ++++++++++----
 reference/spl/spldoublylinkedlist/shift.xml     | 15 +++++++++++----
 reference/spl/spldoublylinkedlist/top.xml       | 15 +++++++++++----
 7 files changed, 80 insertions(+), 30 deletions(-)

diff --git a/reference/spl/spldoublylinkedlist/bottom.xml b/reference/spl/spldoublylinkedlist/bottom.xml
index d2f2a745f2..b0415a00a8 100644
--- a/reference/spl/spldoublylinkedlist/bottom.xml
+++ b/reference/spl/spldoublylinkedlist/bottom.xml
@@ -5,7 +5,7 @@
   <refname>SplDoublyLinkedList::bottom</refname>
   <refpurpose>Peeks at the node from the beginning of the doubly linked list</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -13,19 +13,26 @@
    <void />
   </methodsynopsis>
  </refsect1>
-
+ 
  <refsect1 role="parameters">
   &reftitle.parameters;
   &no.function.parameters;
  </refsect1>
-
+ 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
    The value of the first node.
   </para>
  </refsect1>
-
+ 
+ <refsect1 role="errors"><!-- {{{ -->
+  &reftitle.errors;
+   <para>
+    Throws <classname>RuntimeException</classname> when the data-structure is empty.
+   </para>
+ </refsect1><!-- }}} -->
+ 
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/spl/spldoublylinkedlist/offsetget.xml b/reference/spl/spldoublylinkedlist/offsetget.xml
index 7a2ba5e521..4eec537e91 100644
--- a/reference/spl/spldoublylinkedlist/offsetget.xml
+++ b/reference/spl/spldoublylinkedlist/offsetget.xml
@@ -5,7 +5,7 @@
   <refname>SplDoublyLinkedList::offsetGet</refname>
   <refpurpose>Returns the value at the specified $index</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -13,7 +13,7 @@
    <methodparam><type>mixed</type><parameter>index</parameter></methodparam>
   </methodsynopsis>
  </refsect1>
-
+ 
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
@@ -29,14 +29,23 @@
    </variablelist>
   </para>
  </refsect1>
-
+ 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
    The value at the specified <parameter>index</parameter>.
   </para>
  </refsect1>
-
+ 
+ <refsect1 role="errors"><!-- {{{ -->
+  &reftitle.errors;
+ <para>
+  Throws <classname>OutOfRangeException</classname> when <parameter>index</parameter> is out of bounds
+  or when <parameter>index</parameter> cannot be parsed as an integer.
+ </para>
+ </refsect1><!-- }}} -->
+ 
+ 
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/spl/spldoublylinkedlist/offsetset.xml b/reference/spl/spldoublylinkedlist/offsetset.xml
index 875f60201c..6f9ca52660 100644
--- a/reference/spl/spldoublylinkedlist/offsetset.xml
+++ b/reference/spl/spldoublylinkedlist/offsetset.xml
@@ -5,7 +5,7 @@
   <refname>SplDoublyLinkedList::offsetSet</refname>
   <refpurpose>Sets the value at the specified $index to $newval</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -13,12 +13,12 @@
    <methodparam><type>mixed</type><parameter>index</parameter></methodparam>
    <methodparam><type>mixed</type><parameter>newval</parameter></methodparam>
   </methodsynopsis>
-
+  
   <para>
    Sets the value at the specified <parameter>index</parameter> to <parameter>newval</parameter>.
   </para>
  </refsect1>
-
+ 
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
@@ -42,14 +42,21 @@
    </variablelist>
   </para>
  </refsect1>
-
+ 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
    &return.void;
   </para>
  </refsect1>
-
+ 
+ <refsect1 role="errors"><!-- {{{ -->
+  &reftitle.errors;
+  <para>
+   Throws <classname>OutOfRangeException</classname> when <parameter>index</parameter> is out of bounds or when <parameter>index</parameter> cannot be parsed as an integer.
+  </para>
+ </refsect1><!-- }}} -->
+ 
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/spl/spldoublylinkedlist/offsetunset.xml b/reference/spl/spldoublylinkedlist/offsetunset.xml
index 50db4bda99..d243d11f59 100644
--- a/reference/spl/spldoublylinkedlist/offsetunset.xml
+++ b/reference/spl/spldoublylinkedlist/offsetunset.xml
@@ -5,19 +5,19 @@
   <refname>SplDoublyLinkedList::offsetUnset</refname>
   <refpurpose>Unsets the value at the specified $index</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
    <type>void</type><methodname>SplDoublyLinkedList::offsetUnset</methodname>
    <methodparam><type>mixed</type><parameter>index</parameter></methodparam>
   </methodsynopsis>
-
+  
   <para>
    Unsets the value at the specified index.
   </para>
  </refsect1>
-
+ 
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
@@ -33,14 +33,21 @@
    </variablelist>
   </para>
  </refsect1>
-
+ 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
    &return.void;
   </para>
  </refsect1>
-
+ 
+ <refsect1 role="errors"><!-- {{{ -->
+  &reftitle.errors;
+  <para>
+   Throws <classname>OutOfRangeException</classname> when <parameter>index</parameter> is out of bounds
+   or when <parameter>index</parameter> cannot be parsed as an integer.
+  </para>
+ </refsect1><!-- }}} -->
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/spl/spldoublylinkedlist/pop.xml b/reference/spl/spldoublylinkedlist/pop.xml
index 1881636d39..bdf51be7d5 100644
--- a/reference/spl/spldoublylinkedlist/pop.xml
+++ b/reference/spl/spldoublylinkedlist/pop.xml
@@ -5,7 +5,7 @@
   <refname>SplDoublyLinkedList::pop</refname>
   <refpurpose>Pops a node from the end of the doubly linked list</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -13,19 +13,25 @@
    <void />
   </methodsynopsis>
  </refsect1>
-
+ 
  <refsect1 role="parameters">
   &reftitle.parameters;
   &no.function.parameters;
  </refsect1>
-
+ 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
    The value of the popped node.
   </para>
  </refsect1>
-
+ 
+ <refsect1 role="errors"><!-- {{{ -->
+  &reftitle.errors;
+  <para>
+   Throws <classname>RuntimeException</classname> when the data-structure is empty.
+  </para>
+ </refsect1><!-- }}} -->
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/spl/spldoublylinkedlist/shift.xml b/reference/spl/spldoublylinkedlist/shift.xml
index d9e054500a..fb2beacdd4 100644
--- a/reference/spl/spldoublylinkedlist/shift.xml
+++ b/reference/spl/spldoublylinkedlist/shift.xml
@@ -5,7 +5,7 @@
   <refname>SplDoublyLinkedList::shift</refname>
   <refpurpose>Shifts a node from the beginning of the doubly linked list</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -13,19 +13,26 @@
    <void />
   </methodsynopsis>
  </refsect1>
-
+ 
  <refsect1 role="parameters">
   &reftitle.parameters;
   &no.function.parameters;
  </refsect1>
-
+ 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
    The value of the shifted node.
   </para>
  </refsect1>
-
+ 
+ <refsect1 role="errors"><!-- {{{ -->
+  &reftitle.errors;
+   <para>
+    Throws <classname>RuntimeException</classname> when the data-structure is empty.
+   </para>
+ </refsect1><!-- }}} -->
+ 
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/spl/spldoublylinkedlist/top.xml b/reference/spl/spldoublylinkedlist/top.xml
index e5d635ba27..63dabc651f 100644
--- a/reference/spl/spldoublylinkedlist/top.xml
+++ b/reference/spl/spldoublylinkedlist/top.xml
@@ -5,7 +5,7 @@
   <refname>SplDoublyLinkedList::top</refname>
   <refpurpose>Peeks at the node from the end of the doubly linked list</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -13,19 +13,26 @@
    <void />
   </methodsynopsis>
  </refsect1>
-
+ 
  <refsect1 role="parameters">
   &reftitle.parameters;
   &no.function.parameters;
  </refsect1>
-
+ 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
    The value of the last node.
   </para>
  </refsect1>
-
+ 
+ <refsect1 role="errors"><!-- {{{ -->
+  &reftitle.errors;
+   <para>
+    Throws <classname>RuntimeException</classname> when the data-structure is empty.
+   </para>
+ </refsect1><!-- }}} -->
+ 
 </refentry>
 
 <!-- Keep this comment at the end of the file