Re: My first doc
| From: | Mehdi Achour | Date: | Sat, 06 Jan 2007 23:15:07 +0000 |
| Subject: | Re: My first doc | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969374690@lists.php.net to get a copy of this message | ||
Hi Kevin and welcome :)
Kevin Waterson wrote:
Hi all, just writing my first doc. Here is what I have so far. http://phpro.org/sandbox/readimage.txt Do I need to add anything, get rid of anything? start again?You need to: * get rid of the help comments like: <!-- Example: All functions have this --> * pay attention to indentation (indent = 1 space) : <para>
Reads an image file into the current magickwand object.</para> should be: <para> Reads an image file into the current magickwand object. </para> while
<para>
Absolute path to image file.
</para>
should be:
<para>
Absolute path to image file.
</para>
The "notes" refsect1 also have an indentation problem.
* write the "returnvalues" refsect1
* follow the PEAR coding standards in the example
Please provide a new version once you're done.
Mehdi