Doc #61705 [Opn->Asn]: Incorrect return type documented for CachingIterator->getInnerIterator()

From: Date: Fri, 13 Apr 2012 06:46:56 +0000
Subject: Doc #61705 [Opn->Asn]: Incorrect return type documented for CachingIterator->getInnerIterator()
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-8253@lists.php.net to get a copy of this message
Edit report at https://bugs.php.net/bug.php?id=61705&edit=1 ID: 61705 Updated by: aharvey@php.net Reported by: php-tracker at todofixthis dot com Summary: Incorrect return type documented for CachingIterator->getInnerIterator() -Status: Open +Status: Assigned Type: Documentation Problem Package: Documentation problem Operating System: N/A PHP Version: Irrelevant -Assigned To: +Assigned To: aharvey Block user comment: N Private report: N Previous Comments: ------------------------------------------------------------------------ [2012-04-12 20:49:24] php-tracker at todofixthis dot com Description: ------------ --- From manual page: http://www.php.net/cachingiterator.getinneriterator#refsect1- cachingiterator.getinneriterator-description --- The method signature is documented as: > public void CachingIterator::getInnerIterator ( void ) This is incorrect; the return type should be Iterator, per the documentation in the "Return Values" section: > Returns an object implementing the Iterator interface. The corrected signature would look like this: > public Iterator CachingIterator::getInnerIterator ( void ) Test script: --------------- N/A Expected result: ---------------- N/A Actual result: -------------- N/A ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=61705&edit=1

« previous php.doc.bugs (#8253) next »