[wp-docs] Codex automated page creation for functions?

Tim tcsmith1978 at googlemail.com
Sat Dec 10 08:49:47 UTC 2011


I would second this. Although it would mean a major rework of the Codex
(in fact how it fundamentally functions) I think this would plug the
various gaps in documentation in the Codex in an organised manner. I've
found that reading the WordPress source seems to yield more information
than the Codex itself in some instances which is not ideal. Implementing
this would solve the problem. It would require some discussion with the
development group I would imagine so that they include at least a basic
descriptor of the class/function etc.

On Fri, 2011-12-09 at 12:06 -0500, Eric Lewis wrote:
> Hey all,
> 
> 
> 
> There are many websites out there that automatically parse the phpdoc
> of trunk, creating a very complete, although very big, documentation
> of WP core. 
> 
> 
> 
> Examples:
> 
> 
> http://phpxref.com/xref/wordpress/_functions/index.html
> wpseek.com
> 
> 
> On WP.org there is this: http://phpdoc.wordpress.org/trunk/ which
> catalogs code in a similar manner.
> 
> 
> I'm wondering why functions and their phpdoc are not hooked into the
> Codex at all, at least have pages made automatically for functions. It
> wouldn't clog the codex by creating tons of pages, because these
> functions won't be in a huge list anywhere, however where deemed
> appropriate functions can be linked to from the Functions Reference or
> anywhere else.
> 
> 
> Perhaps a similar process could be employed for actions and hooks.
> 
> 
> The reason I bring this up is because I just used media_sideload_image
> in a project I'm working on and realized there wasn't a Codex page for
> this function, which I made immediately. It would've been nice to at
> least have the PHPdoc there waiting for me, which I used to make the
> basis of the page.
> 
> 
> Eric Lewis
> 
> _______________________________________________
> wp-docs mailing list
> wp-docs at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-docs


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.automattic.com/pipermail/wp-docs/attachments/20111210/8e159e76/attachment.htm>


More information about the wp-docs mailing list