[wp-hackers] Inline documentation

Owen Winkler ringmaster at midnightcircus.com
Thu Feb 16 20:53:22 GMT 2006


Rich Bowen wrote:
> The entire purpose of doing is
> is so that there is inline API documentation. That requires, at a
> miminum, a description of the argument(s) and the return value(s).

While I'm thinking of parameters...

Is there a standard way to document querystring parameters in PHPDoc? 
There are a handful of functions in WP that use them.  They should all 
specify every option and the defaults used when the parameter is not 
included.

Did anyone start a Codex page yet on the formatting for this thing?

Owen




More information about the wp-hackers mailing list