<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 TRANSITIONAL//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=UTF-8">
<META NAME="GENERATOR" CONTENT="GtkHTML/4.1.92">
</HEAD>
<BODY>
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.<BR>
<BR>
On Fri, 2011-12-09 at 12:06 -0500, Eric Lewis wrote:
<BLOCKQUOTE TYPE=CITE>
Hey all,
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<BR>
<BR>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
There are many websites out there that automatically parse the phpdoc of trunk, creating a very complete, although very big, documentation of WP core.
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<BR>
<BR>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
Examples:
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<BR>
<BR>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<A HREF="http://phpxref.com/xref/wordpress/_functions/index.html">http://phpxref.com/xref/wordpress/_functions/index.html</A>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<A HREF="http://wpseek.com">wpseek.com</A>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<BR>
<BR>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
On <A HREF="http://WP.org">WP.org</A> there is this: <A HREF="http://phpdoc.wordpress.org/trunk/">http://phpdoc.wordpress.org/trunk/</A> which catalogs code in a similar manner.
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<BR>
<BR>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
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.
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<BR>
<BR>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
Perhaps a similar process could be employed for actions and hooks.
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<BR>
<BR>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
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.
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<BR>
<BR>
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
Eric Lewis
</BLOCKQUOTE>
<BLOCKQUOTE TYPE=CITE>
<PRE>
_______________________________________________
wp-docs mailing list
<A HREF="mailto:wp-docs@lists.automattic.com">wp-docs@lists.automattic.com</A>
<A HREF="http://lists.automattic.com/mailman/listinfo/wp-docs">http://lists.automattic.com/mailman/listinfo/wp-docs</A>
</PRE>
</BLOCKQUOTE>
<BR>
</BODY>
</HTML>