- MFH Update docu

2 files changed, 25 insertions, 10 deletions

diff --git a/ext/spl/internal/recursiveregexiterator.inc b/ext/spl/internal/recursiveregexiterator.inc
index caaee97b54..21e7599a7d 100755
--- a/ext/spl/internal/recursiveregexiterator.inc
+++ b/ext/spl/internal/recursiveregexiterator.inc
@@ -23,7 +23,13 @@ class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator
 	 * Constructs a regular expression filter around an iterator whose 
 	 * elemnts or keys are strings.
 	 *
-	 * @param it     Object that implements at least
+	 * @param it          inner iterator
+	 * @param regex       the regular expression to match
+	 * @param flags       special flags (self::USE_KEY)
+	 * @param mode        operation mode (one of self::MATCH, self::GET_MATCH, 
+	 *                    self::ALL_MATCHES, self::SPLIT)
+	 * @param preg_flags  global PREG_* flags, see preg_match(), 
+	 *                    preg_match_all(), preg_split()
 	 */
 	function __construct(RecursiveIterator $it, $regex, $flags = 0, $mode = 0, $preg_flags = 0) {
 		parent::__construct($it, $regex, $flags, $mode, $preg_flags);
diff --git a/ext/spl/internal/regexiterator.inc b/ext/spl/internal/regexiterator.inc
index 84ebf986d2..8c38dcc562 100755
--- a/ext/spl/internal/regexiterator.inc
+++ b/ext/spl/internal/regexiterator.inc
@@ -19,24 +19,33 @@
  */
 class RegexIterator implements FilterIterator
 {
-	const USE_KEY     = 0x00000001;
+	const USE_KEY     = 0x00000001; /**< If present in $flags the the key is 
+	                                     used rather then the current value. */
 
-	const MATCH       = 0;
-	const GET_MATCH   = 1;
-	const ALL_MATCHES = 2;
-	const SPLIT       = 3;
+	const MATCH       = 0; /**< Mode: Executed a plain match only      */
+	const GET_MATCH   = 1; /**< Mode: Return the first matche (if any) */
+	const ALL_MATCHES = 2; /**< Mode: Return all matches (if any)      */
+	const SPLIT       = 3; /**< Mode: Return the split values (if any) */
 	
 	private $regex;     /**< the regular expression to match against */
-	private $flags;     /**< special flags (USE_KEY) */
-	private $mode;      /**< operation mode (MATCH, GET_MATCH, ALL_MATCHES, SPLIT) */
-	private $preg_flags;/**< PREG_* flags, see preg_match(), preg_match_all(), preg_split() */ 
+	private $flags;     /**< special flags (self::USE_KEY) */
+	private $mode;      /**< operation mode (one of self::MATCH, 
+	                         self::GET_MATCH, self::ALL_MATCHES, self::SPLIT) */
+	private $preg_flags;/**< PREG_* flags, see preg_match(), preg_match_all(), 
+	                         preg_split() */ 
 	private $current;   /**< the value used for current() */
 
 	/**
 	 * Constructs a regular expression filter around an iterator whose 
 	 * elemnts or keys are strings.
 	 *
-	 * @param it     Object that implements at least
+	 * @param it          inner iterator
+	 * @param regex       the regular expression to match
+	 * @param flags       special flags (self::USE_KEY)
+	 * @param mode        operation mode (one of self::MATCH, self::GET_MATCH, 
+	 *                    self::ALL_MATCHES, self::SPLIT)
+	 * @param preg_flags  global PREG_* flags, see preg_match(), 
+	 *                    preg_match_all(), preg_split()
 	 */
 	function __construct(Iterator $it, $regex, $flags = 0, $mode = 0, $preg_flags = 0) {
 		parent::__construct($it);