[wp-hackers] Inline documentation

[Abhay Kumar]

> > [snip]
> > Yes, that is PHPDoc, and it seems to match perfectly with what I would
> > like to see in the core, (nothing really complex like what Rich has, I
> > love the effort, but the format he suggested in the other list is
> > rather...ick.
>
> Could you elaborate on this? "ick" is rather non-descriptive, and more
> detail would be greatly appreciated.

He is talking about this:

> +/** current_time( $type = ('mysql'|'timestamp')
> +*               [ , $gmt = (true|false) ] )
> +*/
>  function current_time($type, $gmt = 0) {

from your other post. That's not as useful as something like this:

/**
  * @param type string 'mysql' | 'timestamp'
  * @param gmt boolean
  * @return whatever
  */
function current_time($type, $gmt = 0) {

- Abhay
--
Abhay Kumar
http://abhaykumar.net/