[wp-hackers] Inline documentation

[Mark Jaquith]

On Feb 15, 2006, at 11:05 PM, Carthik Sharma wrote:

> Point 1:
> If I were active, I would write up a quickie howto, or guidelines to
> be followed to ensure standardization.
> Could we do one on the wp-includes/ files perhaps, agree on
> format/content to the included and  then proceed with the rest? I
> suppose, otherwise, this will lead to many tickets on trac,
> complaining about incorrect documentation. That, besides the fact that
> otherwise the documentation will be non-uniform.

I'm looking into this, and found this:

http://www.phpdoc.de/doc/introduction.html
>     *  one class per file
>     * eigther procedural or OO code in one file

That would require changes in some WP files.  Now, this is just a  
note about the PHPDoc "parser" (really, just a bunch of greps)... it  
may be that PHPXref has a real parse and could handle multiple  
classes per file and OO/non-OO code mixes like we have throughout WP.

>
> Point 2:
> I would suggest working on a seperate copy of the code repository -
> probably the last stable version (2.0.1) until this work is finished.
> The reason being, it would be nice, for once, to actually make USE of
> version control by opening things up to more than 2-3 people, get the
> work done fast, and then merge back the changes when the documentation
> is mature enough.

Hm, that would certainly speed things up.  I still think WP in  
general would benefit by having one or two more people who commit  
regularly.

Anyway, I'm going to look into the OO/non-OO and multiple classes per  
file issue... see how PHPXref handles that.  If anyone has any  
information on that, please chime in.

--
Mark Jaquith
http://txfx.net/