[wp-hackers] PHPDoc and state of the Codex

Jacob Santos wordpress at santosj.name
Wed Oct 22 02:30:40 GMT 2008

Hey Jennifer,

Thanks, you can find those who helped with the effort or at least most 
of them at http://codex.wordpress.org/Inline_Documentation. You will 
found close to about half a dozen. Good people.

The PHPdoc will not be expanded to include examples. It is not meant to 
be expanded. You will still need to have the function reference on the 
codex or even better an API guide on the codex for the functions. The 
goal was never to provide context to the functions, but to what the 
functions are and their purpose. I thank the contributors to the codex 
and hope they will expand upon what is currently in the phpdoc to have 
context on the codex.

You will find some phpdoc includes links to the codex as well and the 
codex could provide links to the trunk phpdoc site on 
phpdoc.wordpress.org as well.

For the decision on having phpdoc.wordpress.org over 
phpxref.wordpress.org. It was mainly which one would display the phpdoc 
better. I would also like to have a phpxref, but given the choice I 
would always choose phpdoc over phpxref. Peter Westwood's 
phpxref.ftwr.co.uk is a really nice solution for the time being.

Jacob Santos

Jennifer Hodgdon wrote:
> Well, maybe the question is whether we can expand the PHPDoc, for the 
> important functions, so that the PHPDoc has all the detail that the 
> current func/template doc pages have. It should, if that level of 
> detail is useful. I think the main thing missing from the PHPDoc is 
> working examples?
> The other question is whether people could find functions on the 
> phpdoc site. I didn't think the browsing was very intuitive, on first 
> glance (like, what do all those links across the top mean?), and I 
> don't think there is a search function.
> ???
>     Jennifer
> MichaelH wrote:
>> From: "Jennifer Hodgdon" <yahgrp at poplarware.com>
>>> And what about the Template Tags page in the Codex? That is also 
>>> prone to being out of sync, and could be replaced by phpdoc, maybe? 
>>> We could potentially link to the appropriate files that should 
>>> contain template tags. Thoughts?
>> At least for now, I'd suggest leaving the Template Tag articles (e.g. 
>> Template Tags/wp_list_pages) for several reasons:
>> 1. Though some may be 'out of sync', there's a lot of information the 
>> phpdoc site doesn't really detail.
>> 2. Those pages are referred to a zillion times in the Forums.

More information about the wp-hackers mailing list