summaryrefslogtreecommitdiff
path: root/ext/spl/examples/emptyiterator.inc
diff options
context:
space:
mode:
authorMarcus Boerger <helly@php.net>2004-05-08 12:24:15 +0000
committerMarcus Boerger <helly@php.net>2004-05-08 12:24:15 +0000
commita6feb3f405f76f068c6a89058f3382b4ebe4d4f2 (patch)
tree418a89436f73fe362163428419c45fa573c99a44 /ext/spl/examples/emptyiterator.inc
parent26fea0bd809a06b505d9af69e606ded18e565692 (diff)
downloadphp-git-a6feb3f405f76f068c6a89058f3382b4ebe4d4f2.tar.gz
- Update examples
- Update documentation - Move classes/interfaces already implemented in c to new subdir internal
Diffstat (limited to 'ext/spl/examples/emptyiterator.inc')
-rwxr-xr-xext/spl/examples/emptyiterator.inc18
1 files changed, 17 insertions, 1 deletions
diff --git a/ext/spl/examples/emptyiterator.inc b/ext/spl/examples/emptyiterator.inc
index 34b5118e74..1a79173938 100755
--- a/ext/spl/examples/emptyiterator.inc
+++ b/ext/spl/examples/emptyiterator.inc
@@ -1,6 +1,6 @@
<?php
-/**
+/** \ingroup Examples
* @brief An empty Iterator
* @author Marcus Boerger
* @version 1.0
@@ -8,26 +8,42 @@
*/
class EmptyIterator implements Iterator
{
+ /** No operation.
+ * @return void
+ */
function rewind()
{
// nothing to do
}
+ /** @return \c false
+ */
function valid()
{
return false;
}
+ /** This function must not be called. It throws an exception upon access.
+ * @throw Exception
+ * @return void
+ */
function current()
{
throw new Exception('Accessing the value of an EmptyIterator');
}
+ /** This function must not be called. It throws an exception upon access.
+ * @throw Exception
+ * @return void
+ */
function key()
{
throw new Exception('Accessing the key of an EmptyIterator');
}
+ /** No operation.
+ * @return void
+ */
function next()
{
// nothing to do