Hello Jason,

The most up-to-date HOWTO is here:

  https://wiki.php.net/doc/howto

If you're creating a bunch of new documentation, let's say for an entire 
extension, then you could use docgen. Generating skeletons for a PECL extension 
might look like:

  $ cd phpdoc/doc-base/scripts
  $ php docgen.php --extension AwesomeExt --pecl --seealso

See docgen.php --help for details. Docgen uses arginfo/reflection so you're 
extension requires that and must be loaded.

For adding a single function you could use docgen (but with --function) or 
simply copy an XML file and edit. If copying then be sure to change every id. :)

But since it appears you're mostly updating current documentation then you 
should be fine simply editing XML files. Don't be scared, just know that <para> 
is like a <p>, that proper whitespace is MUCH appreciated, and that people love 
reviewing patches! Especially Peter.

For additional help you can ask here or at #php.doc on Efnet. Plenty of good 
people hang out there and love reasons to write text but be patient though as 
response times range from 10-36000 seconds.

Also, please report problems/concerns you run into as the documentation to 
write documentation has issues… something about the cobbler's children having 
no shoes :)

Regards,
Philip, guy who isn't around much these days


On May 9, 2013, at 6:12 PM, Jason Gerfen <jason.ger...@gmail.com> wrote:

> I am currently in the process of reviewing the guidelines, howto & and
> other documentation to submit documentation for some new features added to
> an existing extension.
> 
> Just wanted to say hi and if anyone has any tips, pointers etc. please
> share. Thanks!
> 
> -- 
> Jas
> http://www.github.com/jas-
> 
> <http://phpdhcpadmin.sourceforge.net>

Reply via email to