Re: New PECL documentation

Hey guys, Thank you for the feedback. I will get these done asap and let you know. I think I have spent more time writing and fixing documentation than writing the extension itself =) Pieter On 6/7/10 10:08 AM, "Philip Olson" <philip@roshambo.org> wrote: > > > On Jun 7, 2010, at 12:49 AM, Hannes Magnusson wrote: > >> > On Mon, Jun 7, 2010 at 08:59, Pieter de Zwart >> > <pdezwart@rubiconproject.com> wrote: >>> >> Hey guys, >>> >> >>> >> Since build happens Friday, I waited till now so that I can get a solid >>> week >>> >> of feedback before this gets included in the main docs. I committed revs >>> >> 300253 and 300254. >>> >> I would really appreciate it if someone could give it a look over to make >>> >> sure I am following standards and procedures. >>> >> Once that is done, I will finally make release 0.1 of the client... Only >>> >> about 2 months later than expected. >> > >> > >> > The install section contains a detailed info on how to install the >> > library dependency, but then says: >> > + </programlisting> >> > + <para> >> > + download and compile the <filename>amqp.so</filename> file and add >> > + an <filename>extension</filename> entry in your >> > <filename>php.ini</filename> configuration file. >> > + </para> >> > >> > To install the extension itself.. >> > I'm sure we have a standard entity for installing pecl extensions >> > which would be a lot better. >> > Also note the wrong indenting of the programlisting. >> > >> > The ini section seems to use 2 spaces for indenting rather then the >> > standard 1space > > And this is now online (the doc mirror), which may reveal a few more details > like missing return values. > > - http://docs.php.net/amqp > > Be sure to review each prototype too as docgen defaults to 'void' for skeleton > documentation return types, and usually 'string' for parameter types. And I > assume most of your methods should use one of the following within the > returnvalues role: > > - &return.success; (bool) > - &return.void; (void) > > But overall this is an example of "How to release a PECL extension, the right > way." ;) > > Regards, > Philip