On Wed, May 26, 2010 at 01:37, Pieter de Zwart
<pdezw...@rubiconproject.com> wrote:
> Excellent! Please find the diff attached. The two files are for:
> http://svn.php.net/repository/phpdoc/doc-base/trunk
> And
> http://svn.php.net/repository/phpdoc/en/trunk
>
> Please be brutal, I am a noob =)

Overall I think it looks good, but here are a few things to consider:

- Some of the examples have something like <screen>...</screen>. If
the example doesn't have any output, it's better just leaving the
output part out.

- The entities.*.xml shouldn't be committed. These are generated by
configure.php.

- Some methods have optional parameters. They should have an
<initializer> to show the default value, or if the default is too long
to fit in there they should be explained in the parameters section.

- The XML files should have xml:keywords set to "Id Rev Revision Date
LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL".

- Some of the methods you haven't documented yet have examples like
<?php /* ... */ ?>. If you don't have any example to show yet, just
remove the example section entirely.

- Function names should be enclosed in <function> tags, class names in
<classname> and method names in <methodname>. This will create links
to the relevant pages in the manual and apply special formatting.
Constants should be in <constant>.

-- 
Daniel Egeberg

Reply via email to