[wp-hackers] Proposal for a function commenting convention
wordpress at santosj.name
Wed Oct 17 03:55:09 GMT 2007
@Andy: I was referring to actions I would be taking and patches I'll be
submitting. If anyone wants to join in and do the same for files, then
do please tell me and I won't work on those. Also, it wouldn't do much
good to have people going off in different directions. Conformity in any
case is a good thing. I reference a ticket in my previous post, which
I'm using as an example. You can take a look at it and comment on it.
The more feedback, the better the end result.
That and the whole @package WordPress solves the whole issue. They can
just use @package WordPressMu, for their functions. There is no need to
have additional information with @since and @deprecated. I've been
adding "@package WordPress" to all functions that I've documented so far.
Peter Westwood wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> Marcos Sader | marcosmedia wrote:
>> I still think that there should be a "WP" indicator in case of functions
>> shared between the regular and multiuser version.
>> So WP will get,
>> * @since WP 1.5
>> * @deprecated WP 2.1
>> and WPmu,
>> * @since WPmu 1.5
>> * @deprecated WPmu 2.1
> If you want PHPDoc over in wpmu land then you need to convince the
> people there that it is worth adding and the the @since and @depreceated
> tags can be correctly maintained there.
> WP != WPmu and we don't need WPmu docs in our code.
> - --
> Peter Westwood
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.2 (MingW32)
> Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
> -----END PGP SIGNATURE-----
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
More information about the wp-hackers