[wp-hackers] Inline documentation

[Dave Grijalva]

I agree.  PHPDoc is probably the way to go.  It's a pretty common format,
many C/Java developers will be used to it.  Also, many editors, such as ZDE
already have support for that documentation format.

-dave

On 2/15/06, Owen Winkler <ringmaster at midnightcircus.com> wrote:
>
> Evan Broder wrote:
> > Another thought: it would make sense to use formatting that could be
> > extracted with doxygen or whatever equivalent there is for PHP. That
> > way, we could go create webpages with searchable documentation on all of
> > the functions. I know that when I'm trying to trace a problem through
> > the core, it's always a pain to find all of the various functions in the
> > source.
>
> PHPDoc is reasonably well supported, and both PHP Documentor and PHPXref
> can extract documentation in that format.
>
> I keep a copy of Xref output at http://redalt.com/xref updated from SVN
> twice daily (as do a couple of other folks).  If PHPDoc comments found
> their way into the source, they would appear instantly whenever the Xref
> is regenerated.
>
> More info is available on PHP Documentor at http://www.phpdoc.org/
>
> A copy of Xref docs for Xaraya are at
> http://phpxref.sourceforge.net/phpxref-xaraya/nav.html.gz?index.html.gz
> in case anyone wants to see what PHPDoc looks like and how it appears
> after it's parsed by PHPXref.
>
> Owen
> _______________________________________________
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-hackers
>