[wp-hackers] PHPDoc and state of the Codex

Adam Hunter ah125i at gmail.com
Wed Oct 22 00:52:09 GMT 2008


Hi,
Just my two cents, but I find the PHPDoc template used on
http://framework.zend.com/apidoc/core/
is much more intuitive.  I have set up an example with this template for
2.6.2 here:
http://blueberryware.net/wp-doc-2.6.2/

Thanks

Adam

On Tue, Oct 21, 2008 at 8:33 PM, Jennifer Hodgdon <yahgrp at poplarware.com>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.
>>
>
> --
> Jennifer Hodgdon * Poplar ProductivityWare
> www.poplarware.com
>
> Drupal/WordPress Sites, Themes, Modules/Plugins
> Custom Web Programming, Web Databases
> PHP, Perl, MySQL, JavaScript, XML, AJAX
>
> _______________________________________________
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-hackers
>


More information about the wp-hackers mailing list