Re: ArrayObject docs

From: Date: Sun, 05 Apr 2009 14:02:06 +0000
Subject: Re: ArrayObject docs
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969380318@lists.php.net to get a copy of this message
On Sun, Apr 5, 2009 at 07:33, Juliette <juxecl@gmail.com> wrote: > Hi > I've documented the ArrayObject methods that were tagged with the 'not > documented' warning. Also documented iterator_to_array and iterator_count. > That should be all the SPL docs tagged as not documented, so I'm now > continuing with the rest of ArrayObject. > Let me know if something needs fixing. Nice work! Few comments: - I think it wasn't until 5.3 that ArrayObject implemented Serializable, so the classrefernce page should have a changelog for it. - The ArrayObject->count() example should probably mention count() and an example usage. - Same for the offsetSet()/offsetGet()/.. they should probably contain example of $obj[..] = ..; too - When talking about parameters, they should be wrapped in <parameter>foobar</parameter> to make it more obvious (example; ArrayObject::offsetExists(), "&true; if the requested <parameter>index</parameter> exists, otherwise &false;".. - iterator_to_array(): - <methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam> + <methodparam><type>Object</type><parameter>iterator</parameter></methodpar I don't think this change is correct, the object needs to implement Traversable. Great work on the examples. -Hannes

« previous php.doc (#969380318) next »