sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added the exceptions thrown when you do various things inside of SplDoublyLinkedList.

Browse source 
-- 
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
This commit is contained in:
Levi Morrison 2011-12-13 19:32:36 +00:00
parent ee9d6ef3e1
commit 3eb596f94c
7 changed files with 80 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
reference/spl/spldoublylinkedlist/bottom.xml
View file

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

17
reference/spl/spldoublylinkedlist/offsetget.xml
View file

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

17
reference/spl/spldoublylinkedlist/offsetset.xml
View file

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

17
reference/spl/spldoublylinkedlist/offsetunset.xml
View file

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

14
reference/spl/spldoublylinkedlist/pop.xml
View file

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

15
reference/spl/spldoublylinkedlist/shift.xml
View file

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

15
reference/spl/spldoublylinkedlist/top.xml
View file

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