Re: Re: My first doc

From: Date: Mon, 08 Jan 2007 02:11:00 +0000
Subject: Re: Re: My first doc
References: 1 2 3  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969374726@lists.php.net to get a copy of this message
Please provide a new version once you're done.
So, with the elegant pear coding standard used and the indentation hopefully correct, how are we looking?
While we're looking at it with a fine-toothed comb: <methodparam><type>string</type><parameter>file path</parameter></methodparam> Parameter names are one word. Not sure if that is documented. <term><parameter>string</parameter></term> The parameter name is filepath, not string. Returns TRUE on succss. Throws MagickWandException on failure. Typo success, and use the &true; entity. Also, we should talk about creating something like &exception; and link to it in these cases, mainly due to exceptions not being real common (yet) in PHP. So maybe: Returns &true; on success, or a <literal>MagickWandException</literal> &exception; on failure.
If its good, what next?
Is this a new PECL extension? I can't find it. If so, you'll need to create a new extension/directory in phpdoc: http://doc.php.net/php/dochowto/cvs-add.php I thought this was better documented somewhere, perhaps it is, but pre-existing extensions will provide a good example for structure (and include .cvsignore). Or someone else can set it up. Regards, Philip

« previous php.doc (#969374726) next »